{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key AMPC AssetTypes 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.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitydelete+json", "application/vnd.onkey.entitydeletecollection+json", "application/vnd.onkey.entitymatchupdatecollection+json", "multipart/form-data" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.assetregistertreenode+json", "application/vnd.onkey.assetregistertreenodecollectionpage+json", "*/*" ], "paths": { "/Modules/AMPC/AssetTypeFmecas/{id}": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a Asset Type FMECA 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| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AssetTypeFmeca->Id | integer | int64 |\r\n| isActive | AssetTypeFmeca->IsActive | boolean | |\r\n| isBackup | AssetTypeFmeca->IsBackup | boolean | |\r\n| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| lastConfirmedOn | AssetTypeFmeca->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AssetTypeFmeca->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AssetTypeFmeca->SequenceNumber | integer | int32 |\r\n| createdByUserId | AssetTypeFmeca->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFmeca->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFmeca->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFmeca->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFmeca->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFmeca->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFmeca->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFmeca->ModifiedOn | string | date-time |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmeca->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFmeca->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFmeca->PermissionTree_Description | string | |\r\n| assetTypeId | AssetTypeFmeca->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeFmeca->AssetType_Code | string | |\r\n| assetTypeDescription | AssetTypeFmeca->AssetType_Description | string | |\r\n| assetTypeRecordType | AssetTypeFmeca->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeNearestRegularAssetTypeId | AssetTypeFmeca->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| assetTypeNearestRegularAssetTypeCode | AssetTypeFmeca->AssetType_NearestRegularAssetType_Code | string | |\r\n| assetTypeNearestRegularAssetTypeDescription | AssetTypeFmeca->AssetType_NearestRegularAssetType_Description | string | |\r\n| assetTypeFunctionId | AssetTypeFmeca->AssetTypeFunction_Id | integer | int64 |\r\n| assetTypeFunctionCode | AssetTypeFmeca->AssetTypeFunction_Code | string | |\r\n| assetTypeFunctionDescription | AssetTypeFmeca->AssetTypeFunction_Description | string | |\r\n| componentId | AssetTypeFmeca->Component_Id | integer | int64 |\r\n| componentCode | AssetTypeFmeca->Component_Code | string | |\r\n| componentDescription | AssetTypeFmeca->Component_Description | string | |\r\n| componentRecordType | AssetTypeFmeca->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetTypeId | AssetTypeFmeca->Component_AssetType_Id | integer | int64 |\r\n| componentAssetTypeCode | AssetTypeFmeca->Component_AssetType_Code | string | |\r\n| componentAssetTypeDescription | AssetTypeFmeca->Component_AssetType_Description | string | |\r\n| componentAssetTypeRecordType | AssetTypeFmeca->Component_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetTypeNearestRegularAssetTypeId | AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| componentAssetTypeNearestRegularAssetTypeCode | AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Code | string | |\r\n| componentAssetTypeNearestRegularAssetTypeDescription | AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Description | string | |\r\n| failureCauseId | AssetTypeFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| failureCauseDescription | AssetTypeFmeca->FailureCause_Description | string | |\r\n| failureCauseAdditionalInformation | AssetTypeFmeca->FailureCauseAdditionalInformation | string | |\r\n| failureCauseTypeId | AssetTypeFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | AssetTypeFmeca->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | AssetTypeFmeca->FailureCauseType_Description | string | |\r\n| failureMechanismId | AssetTypeFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureMechanismDescription | AssetTypeFmeca->FailureMechanism_Description | string | |\r\n| failureMechanismAdditionalInformation | AssetTypeFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetTypeFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | AssetTypeFmeca->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | AssetTypeFmeca->FailureMechanismType_Description | string | |\r\n| failureModeId | AssetTypeFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureModeDescription | AssetTypeFmeca->FailureMode_Description | string | |\r\n| failureModeAdditionalInformation | AssetTypeFmeca->FailureModeAdditionalInformation | string | |\r\n| failureModeTypeId | AssetTypeFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | AssetTypeFmeca->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | AssetTypeFmeca->FailureModeType_Description | string | |\r\n| inheritedFromId | AssetTypeFmeca->InheritedFrom_Id | integer | int64 |\r\n| isFailureEvident | AssetTypeFmeca->IsFailureEvident | boolean | |\r\n| isLegacy | AssetTypeFmeca->IsLegacy | boolean | |\r\n| linkedToEntityType | AssetTypeFmeca->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 | AssetTypeFmeca->Notes | string | |\r\n| repairTypeId | AssetTypeFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeCode | AssetTypeFmeca->RepairType_Code | string | |\r\n| repairTypeDescription | AssetTypeFmeca->RepairType_Description | string | |\r\n| repairTypeAdditionalInformation | AssetTypeFmeca->RepairTypeAdditionalInformation | string | |\r\n| warningEffects | AssetTypeFmeca->WarningEffects | string | |\r\n", "operationId": "GetAssetTypeFmeca", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type FMECA", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Type FMECA" ], "summary": "Update an existing Asset Type FMECA resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeFunctionId | AssetTypeFmeca->AssetTypeFunction_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFmeca->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | AssetTypeFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeId | AssetTypeFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetTypeFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetTypeFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismId | AssetTypeFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetTypeFmeca->FailureMechanismAdditionalInformation | string | |\r\n| isFailureEvident | AssetTypeFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetTypeFmeca->WarningEffects | string | |\r\n| failureCauseTypeId | AssetTypeFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseId | AssetTypeFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetTypeFmeca->FailureCauseAdditionalInformation | string | |\r\n| repairTypeId | AssetTypeFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetTypeFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetTypeFmeca->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| failureModeTypeId | Nullable | False | AssetTypeFmeca->FailureCauseType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "UpdateAssetTypeFmeca", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetTypeFmecaResourceActionRequest" } }, { "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 - Asset Type FMECA 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/AssetTypeFmecas": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a collection of Asset Type FMECA 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 | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeCode | AssetTypeFmeca->AssetType_Code | string | |\r\n| assetTypeTreePathItems | AssetTypeFmeca->AssetType_TreePathItems | array | array |\r\n| assetTypeFunctionDescription | AssetTypeFmeca->AssetTypeFunction_Description | string | |\r\n| componentCode | AssetTypeFmeca->Component_Code | string | |\r\n| componentTreePathItems | AssetTypeFmeca->Component_TreePathItems | array | array |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| repairTypeCode | AssetTypeFmeca->RepairType_Code | string | |\r\n| linkedToEntityType | AssetTypeFmeca->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| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetAssetTypeFmecaCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type FMECA collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset Type FMECA" ], "summary": "Create a new Asset Type FMECA resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| assetTypeId | AssetTypeFmeca->AssetType_Id | integer | int64 |\r\n| assetTypeFunctionId | AssetTypeFmeca->AssetTypeFunction_Id | integer | int64 |\r\n| componentId | AssetTypeFmeca->Component_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFmeca->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFmeca->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | AssetTypeFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeId | AssetTypeFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetTypeFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetTypeFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismId | AssetTypeFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetTypeFmeca->FailureMechanismAdditionalInformation | string | |\r\n| isFailureEvident | AssetTypeFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetTypeFmeca->WarningEffects | string | |\r\n| failureCauseTypeId | AssetTypeFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseId | AssetTypeFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetTypeFmeca->FailureCauseAdditionalInformation | string | |\r\n| repairTypeId | AssetTypeFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetTypeFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetTypeFmeca->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| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| componentId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| failureModeTypeId | Nullable | False | AssetTypeFmeca->FailureCauseType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "CreateAssetTypeFmeca", "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/CreateAssetTypeFmecaResourceActionRequest" } }, { "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/InPlaceAssetTypes/{id}/Fmecas": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a collection of AssetType FMECA resources for the InPlace Asset 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 | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeFunctionCode | AssetTypeFmeca->AssetTypeFunction_Code | string | |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetTypeFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFmecaForInPlaceAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Type FMECA collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaForInPlaceAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/{id}/Fmecas": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a collection of Asset Type FMECA resources for the Placeholder Asset 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 | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeFunctionCode | AssetTypeFmeca->AssetTypeFunction_Code | string | |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetTypeFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFmecaForPlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Type FMECA collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaForPlaceholderAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/{id}/Fmecas": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a collection of Asset Type FMECA resources for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeFunctionCode | AssetTypeFmeca->AssetTypeFunction_Code | string | |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetTypeFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFmecaForPlaceholderAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type 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 Type FMECA collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaForPlaceholderAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/{id}/Fmecas": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a collection of AssetType FMECA resources for the Regular Asset 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 | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeFunctionCode | AssetTypeFmeca->AssetTypeFunction_Code | string | |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetTypeFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFmecaForRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Type FMECA collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaForRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/{id}/Fmecas": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a collection of Asset Type FMECA resources for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeFunctionCode | AssetTypeFmeca->AssetTypeFunction_Code | string | |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetTypeFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFmecaForRegularAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type 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 Type FMECA collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaForRegularAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaAssetTypeFunctionFromAssetTypeComponent": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Asset Type Function for the Asset Type FMECA, filtered by Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFunction->Id | integer | int64 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaAssetTypeFunctionFromAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Function collection", "schema": { "$ref": "#/definitions/AssetTypeFmecaAssetTypeFunctionFromAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaAssetTypeFunctionFromAssetType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Asset Type Function for the Asset Type FMECA, filtered by Asset 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 | AssetTypeFunction->Id | integer | int64 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaAssetTypeFunctionFromAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Function collection", "schema": { "$ref": "#/definitions/AssetTypeFmecaAssetTypeFunctionFromAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaAssetType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Asset Type for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetTypeFmecaAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/AssetTypeFmecaRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaChangePermissionTree": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the permission set for changing the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFmecaChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaComponent": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Asset Type Component for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| recordType | AssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetTypeFmecaComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/AssetTypeFmecaComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureCauseFromFailureCauseType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Cause for the Asset Type FMECA, filtered by 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 | FailureCause->Id | integer | int64 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaFailureCauseFromFailureCauseType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureCause": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Cause for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureCause->Id | integer | int64 |\r\n| code | FailureCause->Code | string | |\r\n| description | FailureCause->Description | string | |\r\n| failureCauseTypeId | FailureCause->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | FailureCause->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | FailureCause->FailureCauseType_Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaFailureCause", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureCauseLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureCauseType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Cause Type for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFmecaFailureCauseType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureCauseTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureMechanismFromFailureMechanismType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Mechanism for the Asset Type FMECA, filtered by 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 | FailureMechanism->Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaFailureMechanismFromFailureMechanismType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureMechanismFromAssetTypeFmecaFailureMechanismTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureMechanism": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Mechanism for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMechanism->Id | integer | int64 |\r\n| code | FailureMechanism->Code | string | |\r\n| description | FailureMechanism->Description | string | |\r\n| failureMechanismTypeId | FailureMechanism->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | FailureMechanism->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | FailureMechanism->FailureMechanismType_Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaFailureMechanism", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureMechanismLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureMechanismType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Mechanism Type for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFmecaFailureMechanismType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureMechanismTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureModeFromFailureModeType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Mode for the Asset Type FMECA, filtered by 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 | FailureMode->Id | integer | int64 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaFailureModeFromFailureModeType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureModeFromFailureModeTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureMode": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Mode for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FailureMode->Id | integer | int64 |\r\n| code | FailureMode->Code | string | |\r\n| description | FailureMode->Description | string | |\r\n| failureModeTypeId | FailureMode->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | FailureMode->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | FailureMode->FailureModeType_Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaFailureMode", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureModeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaFailureModeType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Failure Mode Type for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFmecaFailureModeType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaFailureModeTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaInsertPermissionTree": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the permission set for creating the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFmecaInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Lookups/LookupAssetTypeFmecaRepairType": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Lookup the Repair Type for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RepairType->Id | integer | int64 |\r\n| code | RepairType->Code | string | |\r\n| description | RepairType->Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaRepairType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaRepairTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Batch/{ids}": { "get": { "tags": [ "Asset Type FMECA" ], "summary": "Get a collection of Asset Type FMECA 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| developmentStatus | AssetTypeFmeca->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AssetTypeFmeca->Id | integer | int64 |\r\n| isActive | AssetTypeFmeca->IsActive | boolean | |\r\n| isBackup | AssetTypeFmeca->IsBackup | boolean | |\r\n| isInherited | AssetTypeFmeca->IsInherited | boolean | |\r\n| lastConfirmedOn | AssetTypeFmeca->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AssetTypeFmeca->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AssetTypeFmeca->SequenceNumber | integer | int32 |\r\n| createdByUserId | AssetTypeFmeca->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFmeca->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFmeca->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFmeca->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFmeca->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFmeca->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFmeca->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFmeca->ModifiedOn | string | date-time |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmeca->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFmeca->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFmeca->PermissionTree_Description | string | |\r\n| assetTypeId | AssetTypeFmeca->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeFmeca->AssetType_Code | string | |\r\n| assetTypeDescription | AssetTypeFmeca->AssetType_Description | string | |\r\n| assetTypeRecordType | AssetTypeFmeca->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeNearestRegularAssetTypeId | AssetTypeFmeca->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| assetTypeNearestRegularAssetTypeCode | AssetTypeFmeca->AssetType_NearestRegularAssetType_Code | string | |\r\n| assetTypeNearestRegularAssetTypeDescription | AssetTypeFmeca->AssetType_NearestRegularAssetType_Description | string | |\r\n| assetTypeFunctionId | AssetTypeFmeca->AssetTypeFunction_Id | integer | int64 |\r\n| assetTypeFunctionCode | AssetTypeFmeca->AssetTypeFunction_Code | string | |\r\n| assetTypeFunctionDescription | AssetTypeFmeca->AssetTypeFunction_Description | string | |\r\n| componentId | AssetTypeFmeca->Component_Id | integer | int64 |\r\n| componentCode | AssetTypeFmeca->Component_Code | string | |\r\n| componentDescription | AssetTypeFmeca->Component_Description | string | |\r\n| componentRecordType | AssetTypeFmeca->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetTypeId | AssetTypeFmeca->Component_AssetType_Id | integer | int64 |\r\n| componentAssetTypeCode | AssetTypeFmeca->Component_AssetType_Code | string | |\r\n| componentAssetTypeDescription | AssetTypeFmeca->Component_AssetType_Description | string | |\r\n| componentAssetTypeRecordType | AssetTypeFmeca->Component_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetTypeNearestRegularAssetTypeId | AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| componentAssetTypeNearestRegularAssetTypeCode | AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Code | string | |\r\n| componentAssetTypeNearestRegularAssetTypeDescription | AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Description | string | |\r\n| failureCauseId | AssetTypeFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetTypeFmeca->FailureCause_Code | string | |\r\n| failureCauseDescription | AssetTypeFmeca->FailureCause_Description | string | |\r\n| failureCauseAdditionalInformation | AssetTypeFmeca->FailureCauseAdditionalInformation | string | |\r\n| failureCauseTypeId | AssetTypeFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | AssetTypeFmeca->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | AssetTypeFmeca->FailureCauseType_Description | string | |\r\n| failureMechanismId | AssetTypeFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetTypeFmeca->FailureMechanism_Code | string | |\r\n| failureMechanismDescription | AssetTypeFmeca->FailureMechanism_Description | string | |\r\n| failureMechanismAdditionalInformation | AssetTypeFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetTypeFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | AssetTypeFmeca->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | AssetTypeFmeca->FailureMechanismType_Description | string | |\r\n| failureModeId | AssetTypeFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetTypeFmeca->FailureMode_Code | string | |\r\n| failureModeDescription | AssetTypeFmeca->FailureMode_Description | string | |\r\n| failureModeAdditionalInformation | AssetTypeFmeca->FailureModeAdditionalInformation | string | |\r\n| failureModeTypeId | AssetTypeFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | AssetTypeFmeca->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | AssetTypeFmeca->FailureModeType_Description | string | |\r\n| inheritedFromId | AssetTypeFmeca->InheritedFrom_Id | integer | int64 |\r\n| isFailureEvident | AssetTypeFmeca->IsFailureEvident | boolean | |\r\n| isLegacy | AssetTypeFmeca->IsLegacy | boolean | |\r\n| linkedToEntityType | AssetTypeFmeca->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 | AssetTypeFmeca->Notes | string | |\r\n| repairTypeId | AssetTypeFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeCode | AssetTypeFmeca->RepairType_Code | string | |\r\n| repairTypeDescription | AssetTypeFmeca->RepairType_Description | string | |\r\n| repairTypeAdditionalInformation | AssetTypeFmeca->RepairTypeAdditionalInformation | string | |\r\n| warningEffects | AssetTypeFmeca->WarningEffects | string | |\r\n", "operationId": "BatchGetAssetTypeFmeca", "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 Type FMECA 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 Type FMECA collection", "schema": { "$ref": "#/definitions/BatchGetAssetTypeFmecaResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Batch": { "post": { "tags": [ "Asset Type FMECA" ], "summary": "Create a new collection of Asset Type FMECA resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| assetTypeId | AssetTypeFmeca->AssetType_Id | integer | int64 |\r\n| assetTypeFunctionId | AssetTypeFmeca->AssetTypeFunction_Id | integer | int64 |\r\n| componentId | AssetTypeFmeca->Component_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFmeca->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFmeca->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | AssetTypeFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeId | AssetTypeFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetTypeFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetTypeFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismId | AssetTypeFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetTypeFmeca->FailureMechanismAdditionalInformation | string | |\r\n| isFailureEvident | AssetTypeFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetTypeFmeca->WarningEffects | string | |\r\n| failureCauseTypeId | AssetTypeFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseId | AssetTypeFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetTypeFmeca->FailureCauseAdditionalInformation | string | |\r\n| repairTypeId | AssetTypeFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetTypeFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetTypeFmeca->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| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| componentId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| failureModeTypeId | Nullable | False | AssetTypeFmeca->FailureCauseType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchCreateAssetTypeFmeca", "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/BatchCreateAssetTypeFmecaResourceActionRequest" } }, { "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 - Asset Type FMECA 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 Type FMECA" ], "summary": "Update a collection of existing Asset Type FMECA resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| assetTypeFunctionId | AssetTypeFmeca->AssetTypeFunction_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFmeca->SequenceNumber | integer | int32 |\r\n| failureModeTypeId | AssetTypeFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeId | AssetTypeFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetTypeFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetTypeFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismId | AssetTypeFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetTypeFmeca->FailureMechanismAdditionalInformation | string | |\r\n| isFailureEvident | AssetTypeFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetTypeFmeca->WarningEffects | string | |\r\n| failureCauseTypeId | AssetTypeFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseId | AssetTypeFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetTypeFmeca->FailureCauseAdditionalInformation | string | |\r\n| repairTypeId | AssetTypeFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetTypeFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetTypeFmeca->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| id | Min Value | > 0| |\r\n| id | Min Value | > 1| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| failureModeTypeId | Nullable | False | AssetTypeFmeca->FailureCauseType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchUpdateAssetTypeFmeca", "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/BatchUpdateAssetTypeFmecaResourceActionRequest" } }, { "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 - Asset Type FMECA 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/AssetTypeFmecas/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Type FMECA" ], "summary": "Accept the Development Status for an existing Asset Type FMECA resource.", "description": "", "operationId": "AcceptAssetTypeFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA 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/AssetTypeFmecas/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Type FMECA" ], "summary": "Accept the Development Status for the collection of existing Asset Type FMECA resource id's.", "description": "", "operationId": "BatchAcceptAssetTypeFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type FMECA 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/AssetTypeFmecas/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Asset Type FMECA" ], "summary": "Change the Development Status for the collection of existing Asset Type FMECA resource id's.", "description": "", "operationId": "BatchChangeAssetTypeFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type FMECA 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/AssetTypeFmecas/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Type FMECA" ], "summary": "Reject the Development Status for the collection of existing Asset Type FMECA resource id's.", "description": "", "operationId": "BatchRejectAssetTypeFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type FMECA 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/AssetTypeFmecas/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Asset Type FMECA" ], "summary": "Change the Development Status for an existing Asset Type FMECA resource.", "description": "", "operationId": "ChangeAssetTypeFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA 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/AssetTypeFmecas/{id}/Active": { "patch": { "tags": [ "Asset Type FMECA" ], "summary": "Change the IsActive status for an existing Asset Type FMECA resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| isActive | AssetTypeFmeca->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": "ChangeAssetTypeFmecaIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFmecaIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/AssetTypeFmecas/{id}/PermissionTree": { "patch": { "tags": [ "Asset Type FMECA" ], "summary": "Change the PermissionTree for an existing Asset Type FMECA resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmeca->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": "ChangeAssetTypeFmecaPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFmecaPermissionTreeResourceActionRequest" } }, { "$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/AssetTypeFmecas/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Type FMECA" ], "summary": "Reject the Development Status for an existing Asset Type FMECA resource.", "description": "", "operationId": "RejectAssetTypeFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA 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/AssetTypeFmecas/Batch/Active": { "patch": { "tags": [ "Asset Type FMECA" ], "summary": "Change the IsActive status for a collection of existing Asset Type FMECA resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| isActive | AssetTypeFmeca->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| id | Min Value | > 1| |\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": "BatchChangeAssetTypeFmecaIsActive", "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/BatchChangeAssetTypeFmecaIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/AssetTypeFmecas/Batch/PermissionTree": { "patch": { "tags": [ "Asset Type FMECA" ], "summary": "Change the PermissionTree status for a collection of existing Asset Type FMECA resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFmeca->Id | integer | int64 |\r\n| version | AssetTypeFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmeca->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| id | Min Value | > 0| |\r\n| id | Min Value | > 1| |\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": "BatchChangeAssetTypeFmecaPermissionTree", "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/BatchChangeAssetTypeFmecaPermissionTreeResourceActionRequest" } }, { "$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/AssetTypeFmecas/Tasks/{id}": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Get a Asset Type FMECA 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| developmentStatus | AssetTypeFmecaTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AssetTypeFmecaTask->Id | integer | int64 |\r\n| isActive | AssetTypeFmecaTask->IsActive | boolean | |\r\n| isBackup | AssetTypeFmecaTask->IsBackup | boolean | |\r\n| isInherited | AssetTypeFmecaTask->IsInherited | boolean | |\r\n| lastConfirmedOn | AssetTypeFmecaTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AssetTypeFmecaTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AssetTypeFmecaTask->SequenceNumber | integer | int32 |\r\n| createdByUserId | AssetTypeFmecaTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFmecaTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFmecaTask->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFmecaTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFmecaTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFmecaTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFmecaTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFmecaTask->ModifiedOn | string | date-time |\r\n| version | AssetTypeFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmecaTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFmecaTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFmecaTask->PermissionTree_Description | string | |\r\n| assetTypeFmecaId | AssetTypeFmecaTask->AssetTypeFmeca_Id | integer | int64 |\r\n| assetTypeFmecaAssetTypeId | AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Id | integer | int64 |\r\n| assetTypeFmecaAssetTypeCode | AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Code | string | |\r\n| assetTypeFmecaAssetTypeDescription | AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Description | string | |\r\n| inheritedFromId | AssetTypeFmecaTask->InheritedFrom_Id | integer | int64 |\r\n| notes | AssetTypeFmecaTask->Notes | string | |\r\n| regularAssetTypeTaskId | AssetTypeFmecaTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | AssetTypeFmecaTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | AssetTypeFmecaTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskComponentId | AssetTypeFmecaTask->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentCode | AssetTypeFmecaTask->RegularAssetTypeTask_Component_Code | string | |\r\n| regularAssetTypeTaskComponentDescription | AssetTypeFmecaTask->RegularAssetTypeTask_Component_Description | string | |\r\n", "operationId": "GetAssetTypeFmecaTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type FMECA Task", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Type FMECA Task" ], "summary": "Update an existing Asset Type FMECA 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 | AssetTypeFmecaTask->Version | integer | int32 |\r\n| sequenceNumber | AssetTypeFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFmecaTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateAssetTypeFmecaTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetTypeFmecaTaskResourceActionResponse" } }, { "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 - Asset Type FMECA 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/AssetTypeFmecas/Tasks": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Get a collection of Asset Type FMECA 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 | AssetTypeFmecaTask->Id | integer | int64 |\r\n| version | AssetTypeFmecaTask->Version | integer | int32 |\r\n| assetTypeFmecaAssetTypeCode | AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Code | string | |\r\n| assetTypeFmecaComponentCode | AssetTypeFmecaTask->AssetTypeFmeca_Component_Code | string | |\r\n| assetTypeFmecaLinkedToEntityType | AssetTypeFmecaTask->AssetTypeFmeca_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| regularAssetTypeTaskCode | AssetTypeFmecaTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | AssetTypeFmecaTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeTreePathItems | AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_TreePathItems | array | array |\r\n| regularAssetTypeTaskComponentTreePathItems | AssetTypeFmecaTask->RegularAssetTypeTask_Component_TreePathItems | array | array |\r\n| developmentStatus | AssetTypeFmecaTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeFmecaTask->IsInherited | boolean | |\r\n", "operationId": "GetAssetTypeFmecaTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type FMECA Task collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Create a new Asset Type FMECA 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| assetTypeFmecaId | AssetTypeFmecaTask->AssetTypeFmeca_Id | integer | int64 |\r\n| regularAssetTypeTaskId | AssetTypeFmecaTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFmecaTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFmecaTask->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| assetTypeFmecaId | Required | True | |\r\n| assetTypeFmecaId | Nullable | False | |\r\n| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAssetTypeFmecaTask", "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/CreateAssetTypeFmecaTaskResourceActionResponse" } }, { "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/AssetTypeFmecas/{assetTypeFmecaId}/Tasks": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Get a collection of Asset Type FMECA Task resources for the Asset Type FMECA.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFmecaTask->Id | integer | int64 |\r\n| version | AssetTypeFmecaTask->Version | integer | int32 |\r\n| regularAssetTypeTaskCode | AssetTypeFmecaTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | AssetTypeFmecaTask->RegularAssetTypeTask_Description | string | |\r\n| developmentStatus | AssetTypeFmecaTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeFmecaTask->IsInherited | boolean | |\r\n| inheritedFromId | AssetTypeFmecaTask->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFmecaTaskForAssetTypeFmecaCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "assetTypeFmecaId", "in": "path", "required": true, "description": "Asset Type FMECA 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 Type FMECA Task collection", "schema": { "$ref": "#/definitions/GetAssetTypeFmecaTaskForAssetTypeFmecaCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Tasks/Lookups/LookupAssetTypeFmecaTaskAssetTypeFmeca": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Lookup the Asset Type FMECA for the Asset Type FMECA 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 | AssetTypeFmeca->Id | integer | int64 |\r\n| assetTypeId | AssetTypeFmeca->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeFmeca->AssetType_Code | string | |\r\n| assetTypeDescription | AssetTypeFmeca->AssetType_Description | string | |\r\n| componentId | AssetTypeFmeca->Component_Id | integer | int64 |\r\n| componentCode | AssetTypeFmeca->Component_Code | string | |\r\n| componentDescription | AssetTypeFmeca->Component_Description | string | |\r\n", "operationId": "LookupAssetTypeFmecaTaskAssetTypeFmeca", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type FMECA collection", "schema": { "$ref": "#/definitions/AssetTypeFmecaTaskAssetTypeFmecaLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Tasks/Lookups/LookupAssetTypeFmecaTaskRegularAssetTypeTaskFromAssetTypeComponent": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Lookup the Regular Asset Type Task for the Asset Type FMECA Task, filtered by Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeRecordType | RegularAssetTypeTask->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathItems | RegularAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTypeTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTypeTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTypeTask->Component_TreePathItems | array | array |\r\n", "operationId": "LookupAssetTypeFmecaTaskRegularAssetTypeTaskFromAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeComponentLookupResourceActionLookupResourceActionActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Tasks/Lookups/LookupAssetTypeFmecaTaskRegularAssetTypeTaskFromAssetType": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Lookup the Regular Asset Type Task for the Asset Type FMECA Task, filtered by Asset 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeRecordType | RegularAssetTypeTask->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathItems | RegularAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTypeTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTypeTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTypeTask->Component_TreePathItems | array | array |\r\n", "operationId": "LookupAssetTypeFmecaTaskRegularAssetTypeTaskFromAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Tasks/Lookups/LookupAssetTypeFmecaTaskChangePermissionTree": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Lookup the permission set for changing the Asset Type FMECA 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": "LookupAssetTypeFmecaTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Tasks/Lookups/LookupAssetTypeFmecaTaskInsertPermissionTree": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Lookup the permission set for creating the Asset Type FMECA 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": "LookupAssetTypeFmecaTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFmecaTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Tasks/Batch/{ids}": { "get": { "tags": [ "Asset Type FMECA Task" ], "summary": "Get a collection of Asset Type FMECA 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| developmentStatus | AssetTypeFmecaTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AssetTypeFmecaTask->Id | integer | int64 |\r\n| isActive | AssetTypeFmecaTask->IsActive | boolean | |\r\n| isBackup | AssetTypeFmecaTask->IsBackup | boolean | |\r\n| isInherited | AssetTypeFmecaTask->IsInherited | boolean | |\r\n| lastConfirmedOn | AssetTypeFmecaTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AssetTypeFmecaTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AssetTypeFmecaTask->SequenceNumber | integer | int32 |\r\n| createdByUserId | AssetTypeFmecaTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFmecaTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFmecaTask->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFmecaTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFmecaTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFmecaTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFmecaTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFmecaTask->ModifiedOn | string | date-time |\r\n| version | AssetTypeFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmecaTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFmecaTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFmecaTask->PermissionTree_Description | string | |\r\n| assetTypeFmecaId | AssetTypeFmecaTask->AssetTypeFmeca_Id | integer | int64 |\r\n| assetTypeFmecaAssetTypeId | AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Id | integer | int64 |\r\n| assetTypeFmecaAssetTypeCode | AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Code | string | |\r\n| assetTypeFmecaAssetTypeDescription | AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Description | string | |\r\n| inheritedFromId | AssetTypeFmecaTask->InheritedFrom_Id | integer | int64 |\r\n| notes | AssetTypeFmecaTask->Notes | string | |\r\n| regularAssetTypeTaskId | AssetTypeFmecaTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | AssetTypeFmecaTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | AssetTypeFmecaTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskComponentId | AssetTypeFmecaTask->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentCode | AssetTypeFmecaTask->RegularAssetTypeTask_Component_Code | string | |\r\n| regularAssetTypeTaskComponentDescription | AssetTypeFmecaTask->RegularAssetTypeTask_Component_Description | string | |\r\n", "operationId": "BatchGetAssetTypeFmecaTask", "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 Type FMECA 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 Asset Type FMECA Task collection", "schema": { "$ref": "#/definitions/BatchGetAssetTypeFmecaTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFmecas/Tasks/Batch": { "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Create a new collection of Asset Type FMECA 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| assetTypeFmecaId | AssetTypeFmecaTask->AssetTypeFmeca_Id | integer | int64 |\r\n| regularAssetTypeTaskId | AssetTypeFmecaTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFmecaTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFmecaTask->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| assetTypeFmecaId | Required | True | |\r\n| assetTypeFmecaId | Nullable | False | |\r\n| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAssetTypeFmecaTask", "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/BatchCreateAssetTypeFmecaTaskResourceActionRequest" } }, { "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 - Asset Type FMECA 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": [ "Asset Type FMECA Task" ], "summary": "Update a collection of existing Asset Type FMECA 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 | AssetTypeFmecaTask->Id | integer | int64 |\r\n| version | AssetTypeFmecaTask->Version | integer | int32 |\r\n| sequenceNumber | AssetTypeFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFmecaTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateAssetTypeFmecaTask", "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/BatchUpdateAssetTypeFmecaTaskResourceActionResponse" } }, { "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 - Asset Type FMECA 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/AssetTypeFmecas/Tasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Accept the Development Status for an existing Asset Type FMECA Task resource.", "description": "", "operationId": "AcceptAssetTypeFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA 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/AssetTypeFmecas/Tasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Accept the Development Status for the collection of existing Asset Type FMECA Task resource id's.", "description": "", "operationId": "BatchAcceptAssetTypeFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type FMECA 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/AssetTypeFmecas/Tasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Change the Development Status for the collection of existing Asset Type FMECA Task resource id's.", "description": "", "operationId": "BatchChangeAssetTypeFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type FMECA 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/AssetTypeFmecas/Tasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Reject the Development Status for the collection of existing Asset Type FMECA Task resource id's.", "description": "", "operationId": "BatchRejectAssetTypeFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type FMECA 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/AssetTypeFmecas/Tasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Change the Development Status for an existing Asset Type FMECA Task resource.", "description": "", "operationId": "ChangeAssetTypeFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA 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/AssetTypeFmecas/Tasks/{id}/Active": { "patch": { "tags": [ "Asset Type FMECA Task" ], "summary": "Change the IsActive status for an existing Asset Type FMECA 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 | AssetTypeFmecaTask->Version | integer | int32 |\r\n| isActive | AssetTypeFmecaTask->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": "ChangeAssetTypeFmecaTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFmecaTaskIsActiveResourceActionRequest" } }, { "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/AssetTypeFmecas/Tasks/{id}/PermissionTree": { "patch": { "tags": [ "Asset Type FMECA Task" ], "summary": "Change the PermissionTree for an existing Asset Type FMECA 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 | AssetTypeFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmecaTask->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": "ChangeAssetTypeFmecaTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFmecaTaskPermissionTreeResourceActionRequest" } }, { "$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/AssetTypeFmecas/Tasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Type FMECA Task" ], "summary": "Reject the Development Status for an existing Asset Type FMECA Task resource.", "description": "", "operationId": "RejectAssetTypeFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type FMECA 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/AssetTypeFmecas/Tasks/Batch/Active": { "patch": { "tags": [ "Asset Type FMECA Task" ], "summary": "Change the IsActive status for a collection of existing Asset Type FMECA 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 | AssetTypeFmecaTask->Id | integer | int64 |\r\n| version | AssetTypeFmecaTask->Version | integer | int32 |\r\n| isActive | AssetTypeFmecaTask->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": "BatchChangeAssetTypeFmecaTaskIsActive", "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/BatchChangeAssetTypeFmecaTaskIsActiveResourceActionRequest" } }, { "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/AssetTypeFmecas/Tasks/Batch/PermissionTree": { "patch": { "tags": [ "Asset Type FMECA Task" ], "summary": "Change the PermissionTree status for a collection of existing Asset Type FMECA 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 | AssetTypeFmecaTask->Id | integer | int64 |\r\n| version | AssetTypeFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFmecaTask->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": "BatchChangeAssetTypeFmecaTaskPermissionTree", "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/BatchChangeAssetTypeFmecaTaskPermissionTreeResourceActionRequest" } }, { "$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/AssetTypeFolders/{id}": { "get": { "tags": [ "Asset Type Folder" ], "summary": "Get a Asset Type Folder 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 | AssetTypeFolder->Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFolder->SequenceNumber | integer | int32 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| isActive | AssetTypeFolder->IsActive | boolean | |\r\n| createdByUserId | AssetTypeFolder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFolder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFolder->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFolder->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFolder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFolder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFolder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFolder->ModifiedOn | string | date-time |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFolder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFolder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFolder->PermissionTree_Description | string | |\r\n| treePathId | AssetTypeFolder->TreePathId | integer | int64 |\r\n| treePathItems | AssetTypeFolder->TreePathItems | array | array |\r\n| alternativeDescription | AssetTypeFolder->AlternativeDescription | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| notes | AssetTypeFolder->Notes | string | |\r\n| parentAssetTypeFolderId | AssetTypeFolder->ParentAssetTypeFolder_Id | integer | int64 |\r\n| parentAssetTypeFolderCode | AssetTypeFolder->ParentAssetTypeFolder_Code | string | |\r\n| parentAssetTypeFolderDescription | AssetTypeFolder->ParentAssetTypeFolder_Description | string | |\r\n| recordType | AssetTypeFolder->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetAssetTypeFolder", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Folder Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Folder", "schema": { "$ref": "#/definitions/GetAssetTypeFolderResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Type Folder" ], "summary": "Update an existing Asset Type Folder resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| sequenceNumber | AssetTypeFolder->SequenceNumber | integer | int32 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| alternativeDescription | AssetTypeFolder->AlternativeDescription | string | |\r\n| notes | AssetTypeFolder->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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "UpdateAssetTypeFolder", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Folder Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetTypeFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Type Folder 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 Type Folder" ], "summary": "Delete an existing Asset Type Folder resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFolder->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": "DeleteAssetTypeFolder", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Folder Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAssetTypeFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Type Folder 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/AssetTypeFolders": { "get": { "tags": [ "Asset Type Folder" ], "summary": "Get a collection of Asset Type Folder 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 | AssetTypeFolder->Version | integer | int32 |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| alternativeDescription | AssetTypeFolder->AlternativeDescription | string | |\r\n| sequenceNumber | AssetTypeFolder->SequenceNumber | integer | int32 |\r\n| permissionTreeId | AssetTypeFolder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFolder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFolder->PermissionTree_Description | string | |\r\n| parentAssetTypeFolderId | AssetTypeFolder->ParentAssetTypeFolder_Id | integer | int64 |\r\n| parentAssetTypeFolderCode | AssetTypeFolder->ParentAssetTypeFolder_Code | string | |\r\n| parentAssetTypeFolderDescription | AssetTypeFolder->ParentAssetTypeFolder_Description | string | |\r\n| notes | AssetTypeFolder->Notes | string | |\r\n| isActive | AssetTypeFolder->IsActive | boolean | |\r\n| treePathItems | AssetTypeFolder->TreePathItems | array | array |\r\n| createdOn | AssetTypeFolder->CreatedOn | string | date-time |\r\n| modifiedOn | AssetTypeFolder->ModifiedOn | string | date-time |\r\n", "operationId": "GetAssetTypeFolderCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Folder collection", "schema": { "$ref": "#/definitions/GetAssetTypeFolderCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset Type Folder" ], "summary": "Create a new Asset Type Folder resource.", "description": "### Request Body\r\n#### 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 | AssetTypeFolder->AlternativeDescription | string | |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| notes | AssetTypeFolder->Notes | string | |\r\n| parentAssetTypeFolderId | AssetTypeFolder->ParentAssetTypeFolder_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFolder->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFolder->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\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| parentAssetTypeFolderId | Required | True | |\r\n| parentAssetTypeFolderId | Nullable | False | |\r\n| parentAssetTypeFolderId | Min Value | >= 1| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAssetTypeFolder", "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/CreateAssetTypeFolderResourceActionRequest" } }, { "$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/AssetTypeFolders/Lookups/LookupAssetTypeFolderChangePermissionTree": { "get": { "tags": [ "Asset Type Folder" ], "summary": "Lookup the permission set for changing the Asset Type Folder.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFolderChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFolderChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFolders/Lookups/LookupAssetTypeFolderInsertPermissionTree": { "get": { "tags": [ "Asset Type Folder" ], "summary": "Lookup the permission set for creating the Asset Type Folder.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFolderInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFolderInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFolders/Lookups/LookupAssetTypeFolderParentFolder": { "get": { "tags": [ "Asset Type Folder" ], "summary": "Lookup the Asset Type Folder for the Asset Type Folder.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n", "operationId": "LookupAssetTypeFolderParentFolder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Folder collection", "schema": { "$ref": "#/definitions/AssetTypeFolderParentFolderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFolders/Batch/{ids}": { "get": { "tags": [ "Asset Type Folder" ], "summary": "Get a collection of Asset Type Folder 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 | AssetTypeFolder->Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFolder->SequenceNumber | integer | int32 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| isActive | AssetTypeFolder->IsActive | boolean | |\r\n| createdByUserId | AssetTypeFolder->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFolder->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFolder->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFolder->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFolder->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFolder->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFolder->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFolder->ModifiedOn | string | date-time |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFolder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFolder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFolder->PermissionTree_Description | string | |\r\n| treePathId | AssetTypeFolder->TreePathId | integer | int64 |\r\n| treePathItems | AssetTypeFolder->TreePathItems | array | array |\r\n| alternativeDescription | AssetTypeFolder->AlternativeDescription | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| notes | AssetTypeFolder->Notes | string | |\r\n| parentAssetTypeFolderId | AssetTypeFolder->ParentAssetTypeFolder_Id | integer | int64 |\r\n| parentAssetTypeFolderCode | AssetTypeFolder->ParentAssetTypeFolder_Code | string | |\r\n| parentAssetTypeFolderDescription | AssetTypeFolder->ParentAssetTypeFolder_Description | string | |\r\n| recordType | AssetTypeFolder->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "BatchGetAssetTypeFolder", "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 Type Folder 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 Type Folder collection", "schema": { "$ref": "#/definitions/BatchGetAssetTypeFolderResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFolders/Batch": { "post": { "tags": [ "Asset Type Folder" ], "summary": "Create a new collection of Asset Type Folder resources.", "description": "### Request Body\r\n#### 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 | AssetTypeFolder->AlternativeDescription | string | |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| notes | AssetTypeFolder->Notes | string | |\r\n| parentAssetTypeFolderId | AssetTypeFolder->ParentAssetTypeFolder_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFolder->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFolder->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\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| parentAssetTypeFolderId | Required | True | |\r\n| parentAssetTypeFolderId | Nullable | False | |\r\n| parentAssetTypeFolderId | Min Value | >= 1| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAssetTypeFolder", "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/BatchCreateAssetTypeFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Asset Type Folder 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 Type Folder" ], "summary": "Update a collection of existing Asset Type Folder resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| sequenceNumber | AssetTypeFolder->SequenceNumber | integer | int32 |\r\n| description | AssetTypeFolder->Description | string | |\r\n| alternativeDescription | AssetTypeFolder->AlternativeDescription | string | |\r\n| notes | AssetTypeFolder->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| id | Min Value | > 1| |\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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchUpdateAssetTypeFolder", "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/BatchUpdateAssetTypeFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Type Folder 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 Type Folder" ], "summary": "Delete a collection of existing Asset Type Folder resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| version | AssetTypeFolder->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| id | Min Value | > 1| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteAssetTypeFolder", "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/BatchDeleteAssetTypeFolderResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Type Folder 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/AssetTypeFolders/{id}/Active": { "patch": { "tags": [ "Asset Type Folder" ], "summary": "Change the IsActive status for an existing Asset Type Folder resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| isActive | AssetTypeFolder->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": "ChangeAssetTypeFolderIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Folder Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFolderIsActiveResourceActionRequest" } }, { "$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/AssetTypeFolders/{id}/PermissionTree": { "patch": { "tags": [ "Asset Type Folder" ], "summary": "Change the PermissionTree for an existing Asset Type Folder resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFolder->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": "ChangeAssetTypeFolderPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Folder Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFolderPermissionTreeResourceActionRequest" } }, { "$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/AssetTypeFolders/Move": { "post": { "tags": [ "Asset Type Folder" ], "summary": "Move Asset Type Folder.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| sourceId | MoveEntity->SourceId | integer | int64 |\r\n| targetId | MoveEntity->TargetId | integer | int64 |\r\n| targetType | MoveEntity->TargetType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| sourceId | Required | True | |\r\n| sourceId | Nullable | False | |\r\n| targetId | Required | True | |\r\n| targetId | Nullable | False | |\r\n| targetType | Required | True | |\r\n| targetType | Nullable | False | |\r\n\r\n", "operationId": "MoveAssetTypeFolder", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "moveEntity", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MoveAssetTypeFolderResourceActionRequest" } }, { "$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/AssetTypeFolders/Batch/Active": { "patch": { "tags": [ "Asset Type Folder" ], "summary": "Change the IsActive status for a collection of existing Asset Type Folder resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| isActive | AssetTypeFolder->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 | > 1| |\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": "BatchChangeAssetTypeFolderIsActive", "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/BatchChangeAssetTypeFolderIsActiveResourceActionRequest" } }, { "$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/AssetTypeFolders/Batch/PermissionTree": { "patch": { "tags": [ "Asset Type Folder" ], "summary": "Change the PermissionTree status for a collection of existing Asset Type Folder resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| version | AssetTypeFolder->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFolder->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| id | Min Value | > 1| |\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": "BatchChangeAssetTypeFolderPermissionTree", "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/BatchChangeAssetTypeFolderPermissionTreeResourceActionRequest" } }, { "$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/AssetTypeFunctions/{id}": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a Asset Type Function 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| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AssetTypeFunction->Id | integer | int64 |\r\n| isActive | AssetTypeFunction->IsActive | boolean | |\r\n| isBackup | AssetTypeFunction->IsBackup | boolean | |\r\n| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| lastConfirmedOn | AssetTypeFunction->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AssetTypeFunction->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AssetTypeFunction->SequenceNumber | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| createdByUserId | AssetTypeFunction->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFunction->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFunction->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFunction->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFunction->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFunction->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFunction->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFunction->ModifiedOn | string | date-time |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFunction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFunction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFunction->PermissionTree_Description | string | |\r\n| assetTypeId | AssetTypeFunction->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeFunction->AssetType_Code | string | |\r\n| assetTypeRecordType | AssetTypeFunction->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeDescription | AssetTypeFunction->AssetType_Description | string | |\r\n| assetTypeComponentId | AssetTypeFunction->AssetTypeComponent_Id | integer | int64 |\r\n| assetTypeComponentCode | AssetTypeFunction->AssetTypeComponent_Code | string | |\r\n| assetTypeComponentDescription | AssetTypeFunction->AssetTypeComponent_Description | string | |\r\n| assetTypeComponentRecordType | AssetTypeFunction->AssetTypeComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | AssetTypeFunction->Description | string | |\r\n| inheritedFromId | AssetTypeFunction->InheritedFrom_Id | integer | int64 |\r\n| linkedToEntityType | AssetTypeFunction->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 | AssetTypeFunction->Notes | string | |\r\n", "operationId": "GetAssetTypeFunction", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Function Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Function", "schema": { "$ref": "#/definitions/GetAssetTypeFunctionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Type Function" ], "summary": "Update an existing Asset Type Function resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| sequenceNumber | AssetTypeFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFunction->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": "UpdateAssetTypeFunction", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Function Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetTypeFunctionResourceActionResponse" } }, { "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 - Asset Type Function 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/AssetTypeFunctions": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a collection of Asset Type Function 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 | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| assetTypeCode | AssetTypeFunction->AssetType_Code | string | |\r\n| assetTypeTreePathItems | AssetTypeFunction->AssetType_TreePathItems | array | array |\r\n| assetTypeComponentCode | AssetTypeFunction->AssetTypeComponent_Code | string | |\r\n| assetTypeComponentTreePathItems | AssetTypeFunction->AssetTypeComponent_TreePathItems | array | array |\r\n| linkedToEntityType | AssetTypeFunction->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| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetAssetTypeFunctionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Function collection", "schema": { "$ref": "#/definitions/GetAssetTypeFunctionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset Type Function" ], "summary": "Create a new Asset Type Function resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| assetTypeId | AssetTypeFunction->AssetType_Id | integer | int64 |\r\n| assetTypeComponentId | AssetTypeFunction->AssetTypeComponent_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFunction->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFunction->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAssetTypeFunction", "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/CreateAssetTypeFunctionResourceActionResponse" } }, { "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/RegularAssetTypes/{id}/Functions": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a collection of Asset Type Function for the Regular Asset 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 | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | AssetTypeFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFunctionForRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Type Function collection", "schema": { "$ref": "#/definitions/GetAssetTypeFunctionForRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/{id}/Functions": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a collection of Asset Type Function for the Regular Asset 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 | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | AssetTypeFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFunctionForRegularAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type 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 Type Function collection", "schema": { "$ref": "#/definitions/GetAssetTypeFunctionForRegularAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/{id}/Functions": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a collection of Asset Type Function for the InPlace Asset 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 | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | AssetTypeFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFunctionForInPlaceAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Type Function collection", "schema": { "$ref": "#/definitions/GetAssetTypeFunctionForInPlaceAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/{id}/Functions": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a collection of Asset Type Function for the Placeholder Asset 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 | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | AssetTypeFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFunctionForPlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset 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 Asset Type Function collection", "schema": { "$ref": "#/definitions/GetAssetTypeFunctionForPlaceholderAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/{id}/Functions": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a collection of Asset Type Function for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | AssetTypeFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetTypeFunctionForPlaceholderAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type 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 Type Function collection", "schema": { "$ref": "#/definitions/GetAssetTypeFunctionForPlaceholderAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFunctions/Lookups/LookupAssetTypeFunctionAssetTypeComponent": { "get": { "tags": [ "Asset Type Function" ], "summary": "Lookup the Asset Type Component for the Asset Type Function.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| recordType | AssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetTypeFunctionAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/AssetTypeFunctionRegularAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFunctions/Lookups/LookupAssetTypeFunctionChangePermissionTree": { "get": { "tags": [ "Asset Type Function" ], "summary": "Lookup the permission set for changing the Asset Type Function.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFunctionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFunctionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFunctions/Lookups/LookupAssetTypeFunctionInsertPermissionTree": { "get": { "tags": [ "Asset Type Function" ], "summary": "Lookup the permission set for creating the Asset Type Function.", "description": "### Response Body\r\n#### Payload\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": "LookupAssetTypeFunctionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetTypeFunctionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFunctions/Lookups/LookupAssetTypeFunctionAssetType": { "get": { "tags": [ "Asset Type Function" ], "summary": "Lookup the Asset Type for the Asset Type Function.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetTypeFunctionAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/AssetTypeFunctionRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFunctions/Batch/{ids}": { "get": { "tags": [ "Asset Type Function" ], "summary": "Get a collection of Asset Type Function 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| developmentStatus | AssetTypeFunction->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AssetTypeFunction->Id | integer | int64 |\r\n| isActive | AssetTypeFunction->IsActive | boolean | |\r\n| isBackup | AssetTypeFunction->IsBackup | boolean | |\r\n| isInherited | AssetTypeFunction->IsInherited | boolean | |\r\n| lastConfirmedOn | AssetTypeFunction->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AssetTypeFunction->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AssetTypeFunction->SequenceNumber | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| createdByUserId | AssetTypeFunction->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetTypeFunction->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetTypeFunction->CreatedByUser_FullName | string | |\r\n| createdOn | AssetTypeFunction->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetTypeFunction->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetTypeFunction->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetTypeFunction->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetTypeFunction->ModifiedOn | string | date-time |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFunction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFunction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFunction->PermissionTree_Description | string | |\r\n| assetTypeId | AssetTypeFunction->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeFunction->AssetType_Code | string | |\r\n| assetTypeRecordType | AssetTypeFunction->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeDescription | AssetTypeFunction->AssetType_Description | string | |\r\n| assetTypeComponentId | AssetTypeFunction->AssetTypeComponent_Id | integer | int64 |\r\n| assetTypeComponentCode | AssetTypeFunction->AssetTypeComponent_Code | string | |\r\n| assetTypeComponentDescription | AssetTypeFunction->AssetTypeComponent_Description | string | |\r\n| assetTypeComponentRecordType | AssetTypeFunction->AssetTypeComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | AssetTypeFunction->Description | string | |\r\n| inheritedFromId | AssetTypeFunction->InheritedFrom_Id | integer | int64 |\r\n| linkedToEntityType | AssetTypeFunction->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 | AssetTypeFunction->Notes | string | |\r\n", "operationId": "BatchGetAssetTypeFunction", "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 Type Function 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 Type Function collection", "schema": { "$ref": "#/definitions/BatchGetAssetTypeFunctionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypeFunctions/Batch": { "post": { "tags": [ "Asset Type Function" ], "summary": "Create a new collection of Asset Type Function resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| assetTypeId | AssetTypeFunction->AssetType_Id | integer | int64 |\r\n| assetTypeComponentId | AssetTypeFunction->AssetTypeComponent_Id | integer | int64 |\r\n| permissionTreeId | AssetTypeFunction->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetTypeFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFunction->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAssetTypeFunction", "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/BatchCreateAssetTypeFunctionResourceActionRequest" } }, { "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 - Asset Type Function 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 Type Function" ], "summary": "Update a collection of existing Asset Type Function resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| code | AssetTypeFunction->Code | string | |\r\n| description | AssetTypeFunction->Description | string | |\r\n| sequenceNumber | AssetTypeFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetTypeFunction->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| id | Min Value | > 1| |\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": "BatchUpdateAssetTypeFunction", "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/BatchUpdateAssetTypeFunctionResourceActionResponse" } }, { "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 - Asset Type Function 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/AssetTypeFunctions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Type Function" ], "summary": "Accept the Development Status for an existing Asset Type Function resource.", "description": "", "operationId": "AcceptAssetTypeFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Function 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/AssetTypeFunctions/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Type Function" ], "summary": "Accept the Development Status for the collection of existing Asset Type Function resource id's.", "description": "", "operationId": "BatchAcceptAssetTypeFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type Function 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/AssetTypeFunctions/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Asset Type Function" ], "summary": "Change the Development Status for the collection of existing Asset Type Function resource id's.", "description": "", "operationId": "BatchChangeAssetTypeFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type Function 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/AssetTypeFunctions/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Type Function" ], "summary": "Reject the Development Status for the collection of existing Asset Type Function resource id's.", "description": "", "operationId": "BatchRejectAssetTypeFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Type Function 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/AssetTypeFunctions/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Asset Type Function" ], "summary": "Change the Development Status for an existing Asset Type Function resource.", "description": "", "operationId": "ChangeAssetTypeFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Function 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/AssetTypeFunctions/{id}/Active": { "patch": { "tags": [ "Asset Type Function" ], "summary": "Change the IsActive status for an existing Asset Type Function resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| isActive | AssetTypeFunction->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": "ChangeAssetTypeFunctionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Function Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFunctionIsActiveResourceActionRequest" } }, { "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/AssetTypeFunctions/{id}/PermissionTree": { "patch": { "tags": [ "Asset Type Function" ], "summary": "Change the PermissionTree for an existing Asset Type Function resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFunction->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": "ChangeAssetTypeFunctionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Function Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetTypeFunctionPermissionTreeResourceActionRequest" } }, { "$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/AssetTypeFunctions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Type Function" ], "summary": "Reject the Development Status for an existing Asset Type Function resource.", "description": "", "operationId": "RejectAssetTypeFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Type Function 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/AssetTypeFunctions/Batch/Active": { "patch": { "tags": [ "Asset Type Function" ], "summary": "Change the IsActive status for a collection of existing Asset Type Function resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| isActive | AssetTypeFunction->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 | > 1| |\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": "BatchChangeAssetTypeFunctionIsActive", "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/BatchChangeAssetTypeFunctionIsActiveResourceActionRequest" } }, { "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/AssetTypeFunctions/Batch/PermissionTree": { "patch": { "tags": [ "Asset Type Function" ], "summary": "Change the PermissionTree status for a collection of existing Asset Type Function resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFunction->Id | integer | int64 |\r\n| version | AssetTypeFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetTypeFunction->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| id | Min Value | > 1| |\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": "BatchChangeAssetTypeFunctionPermissionTree", "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/BatchChangeAssetTypeFunctionPermissionTreeResourceActionRequest" } }, { "$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/AssetTypes/Tree/{nodeType}/{id}/PathMap": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of tree nodes that contains the path map to navigate to the resource within the tree.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TreePathMapNode->Id | integer | int64 |\r\n| code | TreePathMapNode->Code | string | |\r\n| recordType | TreePathMapNode->RecordType | string | |\r\n| treeLevel | TreePathMapNode->TreeLevel | integer | int32 |\r\n| type | TreePathMapNode->Type | string | enum |\r\n", "operationId": "GetAssetTypeTreePathMap", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "nodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, AssetTypeTaskResources, AssetTypeTaskSpares, RegularAssetTypeTasks, AuxiliaryAssetTypeTasks, RegularAssetTypeTaskFollowUpTasks, AuxiliaryAssetTypeTasks, RegularAssetTypeTaskFollowUpTasks, RegularAssetTypeTaskSuppressedTasks, RegularAssetTypeTaskAuxiliaryTasks, RegularAssetTypeTaskSpares, RegularAssetTypeTaskConditions]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Node Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/GetAssetTypeTreePathMapResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/ChangedEntities/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a list of Changed Entity for parent node", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | ChangedEntity->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| entityIds | ChangedEntity->EntityIds | array | array |\r\n", "operationId": "GetTreeGetAssetTypeChangedEntities", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeGetAssetTypeChangedEntitiesResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type resources for the Root node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n", "operationId": "GetAssetTypeTreeRoot", "produces": [ "application/vnd.onkey.assetregistertreenode+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/AssetTypeComponents/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type Component resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeComponent->Id | integer | int64 |\r\n| version | AssetTypeComponent->Version | integer | int32 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| alternativeDescription | AssetTypeComponent->AlternativeDescription | string | |\r\n| isActive | AssetTypeComponent->IsActive | boolean | |\r\n| sequenceNumber | AssetTypeComponent->SequenceNumber | integer | int32 |\r\n| partNumber | AssetTypeComponent->PartNumber | string | |\r\n| supplierPartNumber | AssetTypeComponent->SupplierPartNumber | string | |\r\n| recordType | AssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | AssetTypeComponent->Quantity | integer | int32 |\r\n| supplierId | AssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | AssetTypeComponent->Supplier_Description | string | |\r\n| parentComponentId | AssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | AssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | AssetTypeComponent->ParentComponent_Description | string | |\r\n| assetTypeId | AssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | AssetTypeComponent->AssetType_Description | string | |\r\n| assetTypeTreePathItems | AssetTypeComponent->AssetType_TreePathItems | array | array |\r\n| developmentStatus | AssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AssetTypeComponent->IsInherited | boolean | |\r\n| treePathItems | AssetTypeComponent->TreePathItems | array | array |\r\n| rulesLastChangedOn | AssetTypeComponent->RulesLastChangedOn | string | date-time |\r\n| permissionTreeId | AssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeComponent->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAssetTypeComponentsRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTypeComponentsRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/AssetTypeFolders": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type Folder resources beneath the parent tree node.", "description": "### Response Body\r\n#### 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 | AssetTypeFolder->Version | integer | int32 |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| alternativeDescription | AssetTypeFolder->AlternativeDescription | string | |\r\n| sequenceNumber | AssetTypeFolder->SequenceNumber | integer | int32 |\r\n| isActive | AssetTypeFolder->IsActive | boolean | |\r\n", "operationId": "GetTreeAssetTypeFolderCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypeFolders]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/AssetTypeFolders/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type Folder resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### 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 | AssetTypeFolder->Version | integer | int32 |\r\n| id | AssetTypeFolder->Id | integer | int64 |\r\n| code | AssetTypeFolder->Code | string | |\r\n| description | AssetTypeFolder->Description | string | |\r\n| alternativeDescription | AssetTypeFolder->AlternativeDescription | string | |\r\n| sequenceNumber | AssetTypeFolder->SequenceNumber | integer | int32 |\r\n| recordType | AssetTypeFolder->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| permissionTreeId | AssetTypeFolder->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeFolder->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeFolder->PermissionTree_Description | string | |\r\n| parentAssetTypeFolderId | AssetTypeFolder->ParentAssetTypeFolder_Id | integer | int64 |\r\n| parentAssetTypeFolderCode | AssetTypeFolder->ParentAssetTypeFolder_Code | string | |\r\n| parentAssetTypeFolderDescription | AssetTypeFolder->ParentAssetTypeFolder_Description | string | |\r\n| notes | AssetTypeFolder->Notes | string | |\r\n| createdOn | AssetTypeFolder->CreatedOn | string | date-time |\r\n| modifiedOn | AssetTypeFolder->ModifiedOn | string | date-time |\r\n", "operationId": "GetTreeAssetTypeFolderRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTypeFolderRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/AssetTypes/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### 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 | AssetType->Version | integer | int32 |\r\n| id | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| alternativeDescription | AssetType->AlternativeDescription | string | |\r\n| sequenceNumber | AssetType->SequenceNumber | integer | int32 |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| permissionTreeId | AssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetType->PermissionTree_Description | string | |\r\n| createdOn | AssetType->CreatedOn | string | date-time |\r\n| isActive | AssetType->IsActive | boolean | |\r\n| parentAssetTypeId | AssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | AssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | AssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | AssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| developmentStatus | AssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| treePathItems | AssetType->TreePathItems | array | array |\r\n| modifiedOn | AssetType->ModifiedOn | string | date-time |\r\n", "operationId": "GetTreeAssetTypesRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTypesRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/AssetTypeTaskResources/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type Task Resource resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeTaskResource->Id | integer | int64 |\r\n| version | AssetTypeTaskResource->Version | integer | int32 |\r\n| isActive | AssetTypeTaskResource->IsActive | boolean | |\r\n| assetTypeTaskId | AssetTypeTaskResource->AssetTypeTask_Id | integer | int64 |\r\n| assetTypeTaskCode | AssetTypeTaskResource->AssetTypeTask_Code | string | |\r\n| assetTypeTaskDescription | AssetTypeTaskResource->AssetTypeTask_Description | string | |\r\n| assetTypeTaskRecordType | AssetTypeTaskResource->AssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| assetTypeTaskAssetTypeId | AssetTypeTaskResource->AssetTypeTask_AssetType_Id | integer | int64 |\r\n| assetTypeTaskAssetTypeCode | AssetTypeTaskResource->AssetTypeTask_AssetType_Code | string | |\r\n| assetTypeTaskAssetTypeDescription | AssetTypeTaskResource->AssetTypeTask_AssetType_Description | string | |\r\n| assetTypeTaskAssetTypeTreePathItems | AssetTypeTaskResource->AssetTypeTask_AssetType_TreePathItems | array | array |\r\n| assetTypeTaskComponentId | AssetTypeTaskResource->AssetTypeTask_Component_Id | integer | int64 |\r\n| assetTypeTaskComponentTreePathItems | AssetTypeTaskResource->AssetTypeTask_Component_TreePathItems | array | array |\r\n| resourceId | AssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AssetTypeTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | AssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceResourceType | AssetTypeTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceDescription | AssetTypeTaskResource->Resource_Description | string | |\r\n| quantity | AssetTypeTaskResource->Quantity | integer | int32 |\r\n| usage | AssetTypeTaskResource->Usage | object | composite |\r\n| proficiency | AssetTypeTaskResource->Proficiency | integer | int32 |\r\n| sectionId | AssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | AssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | AssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | AssetTypeTaskResource->Trade_Description | string | |\r\n| competencyId | AssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | AssetTypeTaskResource->Competency_Description | string | |\r\n| isInherited | AssetTypeTaskResource->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| notes | AssetTypeTaskResource->Notes | string | |\r\n| sequenceNumber | AssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | AssetTypeTaskResource->RulesLastChangedOn | string | date-time |\r\n| permissionTreeId | AssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeTaskResource->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAssetTypeTaskResourcesRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks, AuxiliaryAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTypeTaskResourcesRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/AssetTypeTaskSpares/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type Task Spare resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeTaskSpare->Id | integer | int64 |\r\n| version | AssetTypeTaskSpare->Version | integer | int32 |\r\n| materialMasterId | AssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | AssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AssetTypeTaskSpare->CostElement_Description | string | |\r\n| quantity | AssetTypeTaskSpare->Quantity | number | decimal |\r\n| assetTypeTaskId | AssetTypeTaskSpare->AssetTypeTask_Id | integer | int64 |\r\n| assetTypeTaskCode | AssetTypeTaskSpare->AssetTypeTask_Code | string | |\r\n| assetTypeTaskDescription | AssetTypeTaskSpare->AssetTypeTask_Description | string | |\r\n| assetTypeTaskRecordType | AssetTypeTaskSpare->AssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| assetTypeTaskAssetTypeId | AssetTypeTaskSpare->AssetTypeTask_AssetType_Id | integer | int64 |\r\n| assetTypeTaskAssetTypeCode | AssetTypeTaskSpare->AssetTypeTask_AssetType_Code | string | |\r\n| assetTypeTaskAssetTypeDescription | AssetTypeTaskSpare->AssetTypeTask_AssetType_Description | string | |\r\n| assetTypeTaskAssetTypeTreePathItems | AssetTypeTaskSpare->AssetTypeTask_AssetType_TreePathItems | array | array |\r\n| assetTypeTaskComponentId | AssetTypeTaskSpare->AssetTypeTask_Component_Id | integer | int64 |\r\n| assetTypeTaskComponentTreePathItems | AssetTypeTaskSpare->AssetTypeTask_Component_TreePathItems | array | array |\r\n| isInherited | AssetTypeTaskSpare->IsInherited | boolean | |\r\n| developmentStatus | AssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| rulesLastChangedOn | AssetTypeTaskSpare->RulesLastChangedOn | string | date-time |\r\n| permissionTreeId | AssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeTaskSpare->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAssetTypeTaskSparesRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks, AuxiliaryAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTypeTaskSparesRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/AssetTypeTasks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Asset Type Task resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeTask->Id | integer | int64 |\r\n| version | AssetTypeTask->Version | integer | int32 |\r\n| code | AssetTypeTask->Code | string | |\r\n| recordType | AssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| description | AssetTypeTask->Description | string | |\r\n| alternativeDescription | AssetTypeTask->AlternativeDescription | string | |\r\n| isInherited | AssetTypeTask->IsInherited | boolean | |\r\n| inheritedFromId | AssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AssetTypeTask->SequenceNumber | integer | int32 |\r\n| assetTypeId | AssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | AssetTypeTask->AssetType_Description | string | |\r\n| assetTypeTreePathItems | AssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | AssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | AssetTypeTask->Component_Code | string | |\r\n| componentDescription | AssetTypeTask->Component_Description | string | |\r\n| componentRecordType | AssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | AssetTypeTask->Component_TreePathItems | array | array |\r\n| permissionTreeId | AssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTypeTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTypeTask->PermissionTree_Description | string | |\r\n| isInspection | AssetTypeTask->IsInspection | boolean | |\r\n| isNonUsageBasedReadingRequired | AssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | AssetTypeTask->IsMandatory | boolean | |\r\n| importanceCode | AssetTypeTask->Importance_Code | string | |\r\n| rulesLastChangedOn | AssetTypeTask->RulesLastChangedOn | string | date-time |\r\n| intervalType1Id | AssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | AssetTypeTask->IntervalType1_Code | string | |\r\n| intervalType1Description | AssetTypeTask->IntervalType1_Description | string | |\r\n| intervalType2Id | AssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | AssetTypeTask->IntervalType2_Code | string | |\r\n| intervalType2Description | AssetTypeTask->IntervalType2_Description | string | |\r\n", "operationId": "GetTreeAssetTypeTasksRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTypeTasksRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/AuxiliaryAssetTypeTasks": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Auxiliary Asset Type Task resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| isActive | AuxiliaryAssetTypeTask->IsActive | boolean | |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | AuxiliaryAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | AuxiliaryAssetTypeTask->IsInherited | boolean | |\r\n| recordType | AuxiliaryAssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| assetTypeId | AuxiliaryAssetTypeTask->AssetType_Id | integer | int64 |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n", "operationId": "GetTreeAuxiliaryAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/AuxiliaryAssetTypeTasks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Auxiliary Asset Type Task resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| recordType | AuxiliaryAssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| isInherited | AuxiliaryAssetTypeTask->IsInherited | boolean | |\r\n| inheritedFromId | AuxiliaryAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AuxiliaryAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->SequenceNumber | integer | int32 |\r\n| assetTypeId | AuxiliaryAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AuxiliaryAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | AuxiliaryAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeTreePathItems | AuxiliaryAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | AuxiliaryAssetTypeTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTypeTask->Component_Description | string | |\r\n| componentRecordType | AuxiliaryAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | AuxiliaryAssetTypeTask->Component_TreePathItems | array | array |\r\n| permissionTreeId | AuxiliaryAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTask->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAuxiliaryAssetTypeTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeAuxiliaryAssetTypeTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/InPlaceAssetTypes": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of In-Place Asset Type resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | InPlaceAssetType->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetType->IsInherited | boolean | |\r\n| recordType | InPlaceAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| parentAssetTypeId | InPlaceAssetType->ParentAssetType_Id | integer | int64 |\r\n| isActive | InPlaceAssetType->IsActive | boolean | |\r\n", "operationId": "GetTreeInPlaceAssetTypeCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/InPlaceAssetTypes/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of In-Place Asset Type resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | InPlaceAssetType->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetType->IsInherited | boolean | |\r\n| recordType | InPlaceAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| parentAssetTypeId | InPlaceAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | InPlaceAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | InPlaceAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | InPlaceAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetTreeInPlaceAssetTypeRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeInPlaceAssetTypeRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/PlaceholderAssetTypes": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Placeholder Asset Type resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| isActive | PlaceholderAssetType->IsActive | boolean | |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | PlaceholderAssetType->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetType->IsInherited | boolean | |\r\n| recordType | PlaceholderAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| parentAssetTypeId | PlaceholderAssetType->ParentAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCanSelectOnAsset | PlaceholderAssetType->LinkedToAssetType_CanSelectOnAsset | boolean | |\r\n", "operationId": "GetTreePlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/PlaceholderAssetTypeComponents": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Placeholder Asset Type Component resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| isActive | PlaceholderAssetTypeComponent->IsActive | boolean | |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| recordType | PlaceholderAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| developmentStatus | PlaceholderAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponent->IsInherited | boolean | |\r\n| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n", "operationId": "GetTreePlaceholderAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/PlaceholderAssetTypeComponents/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Placeholder Asset Type Component resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| isActive | PlaceholderAssetTypeComponent->IsActive | boolean | |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | string | |\r\n| recordType | PlaceholderAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetTypeComponent->AssetType_Description | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Description | string | |\r\n| linkedToAssetTypeId | PlaceholderAssetTypeComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetTypeComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetTypeComponent->LinkedToAssetType_Description | string | |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | PlaceholderAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | PlaceholderAssetTypeComponent->ParentComponent_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetTypeComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetTypeComponent->AssetImportance_Description | string | |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetTypeComponent->Supplier_Description | string | |\r\n| notes | PlaceholderAssetTypeComponent->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeComponent->ModifiedOn | string | date-time |\r\n", "operationId": "GetTreePlaceholderAssetTypeComponentRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreePlaceholderAssetTypeComponentRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/PlaceholderAssetTypes/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Placeholder Asset Type resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### 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 | PlaceholderAssetType->Version | integer | int32 |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | PlaceholderAssetType->SequenceNumber | integer | int32 |\r\n| recordType | PlaceholderAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| developmentStatus | PlaceholderAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| placeholderForAssetTypeId | PlaceholderAssetType->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetType->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetType->PlaceholderForAssetType_Description | string | |\r\n| linkedToAssetTypeId | PlaceholderAssetType->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetType->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetType->LinkedToAssetType_Description | string | |\r\n| parentAssetTypeId | PlaceholderAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | PlaceholderAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | PlaceholderAssetType->ParentAssetType_Description | string | |\r\n| createdOn | PlaceholderAssetType->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetType->ModifiedOn | string | date-time |\r\n", "operationId": "GetTreePlaceholderAssetTypeRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreePlaceholderAssetTypeRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/RegularAssetTypes": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| isActive | RegularAssetType->IsActive | boolean | |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetType->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| recordType | RegularAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n", "operationId": "GetTreeRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypeFolders, RegularAssetTypes]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/RegularAssetTypeComponents": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Component resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| isActive | RegularAssetTypeComponent->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| recordType | RegularAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| developmentStatus | RegularAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponent->IsInherited | boolean | |\r\n| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| parentComponentId | RegularAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n", "operationId": "GetTreeRegularAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeComponents/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Component resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| isActive | RegularAssetTypeComponent->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n| recordType | RegularAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetTypeComponent->Supplier_Description | string | |\r\n| parentComponentId | RegularAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | RegularAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | RegularAssetTypeComponent->ParentComponent_Description | string | |\r\n| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeComponent->AssetType_Description | string | |\r\n| developmentStatus | RegularAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| createdOn | RegularAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeComponent->ModifiedOn | string | date-time |\r\n", "operationId": "GetTreeRegularAssetTypeComponentRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeComponentRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypes/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type resources beneath the parent tree node.", "description": "### Response Body\r\n#### 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 | RegularAssetType->Version | integer | int32 |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetType->SequenceNumber | integer | int32 |\r\n| recordType | RegularAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| developmentStatus | RegularAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| parentAssetTypeId | RegularAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | RegularAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | RegularAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | RegularAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| createdOn | RegularAssetType->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetType->ModifiedOn | string | date-time |\r\n", "operationId": "GetTreeRegularAssetTypeRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/RegularAssetTypeTaskAuxiliaryTasks": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Auxiliary Task resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskAuxiliaryTask->IsInherited | boolean | |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryTaskAlternativeDescription | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskAuxiliaryTask->IsActive | boolean | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskAuxiliaryTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTaskAuxiliaryTasks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Auxiliary Task resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskAuxiliaryTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| permissionTreeId | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskAuxiliaryTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskAuxiliaryTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/RegularAssetTypeTasks": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| isActive | RegularAssetTypeTask->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTask->IsInherited | boolean | |\r\n| recordType | RegularAssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTypeTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTypeTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTypeTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTypeTask->IntervalType2_Description | string | |\r\n| inheritedFromCode | RegularAssetTypeTask->InheritedFrom_Code | string | |\r\n| inheritedFromRecordType | RegularAssetTypeTask->InheritedFrom_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTypeTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTypeTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTypeTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTypeTask->DefaultInterval2_Description | string | |\r\n| derivedFromStandardTask | RegularAssetTypeTask->DerivedFromStandardTask | boolean | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTaskConditions/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Condition resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskIntervalType1Id | RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeTaskCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetTypeTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeTaskCondition->Condition_ConditionType_Description | string | |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTypeTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTypeTaskCondition->Interval_Description | string | |\r\n| isActive | RegularAssetTypeTaskCondition->IsActive | boolean | |\r\n| isInherited | RegularAssetTypeTaskCondition->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | RegularAssetTypeTaskCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetTreeRegularAssetTypeTaskConditionsRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks, AuxiliaryAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskConditionsRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/RegularAssetTypeTaskFollowUpTasks": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Follow Up Task resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskFollowUpTask->IsInherited | boolean | |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| followUpTaskAlternativeDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskFollowUpTask->IsActive | boolean | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskFollowUpTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTaskFollowUpTasks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Follow Up Task resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskFollowUpTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeTreePathItems | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_AssetType_TreePathItems | array | array |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentTreePathItems | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Component_TreePathItems | array | array |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskFollowUpTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskFollowUpTask->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskFollowUpTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskFollowUpTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTasks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| isInherited | RegularAssetTypeTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| developmentStatus | RegularAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeRecordType | RegularAssetTypeTask->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathItems | RegularAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTypeTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTypeTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTypeTask->Component_TreePathItems | array | array |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| importanceCode | RegularAssetTypeTask->Importance_Code | string | |\r\n| rulesLastChangedOn | RegularAssetTypeTask->RulesLastChangedOn | string | date-time |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTypeTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTypeTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTypeTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTypeTask->IntervalType2_Description | string | |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | RegularAssetTypeTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | RegularAssetTypeTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | RegularAssetTypeTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | RegularAssetTypeTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | RegularAssetTypeTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | RegularAssetTypeTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | RegularAssetTypeTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | RegularAssetTypeTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | RegularAssetTypeTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | RegularAssetTypeTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | RegularAssetTypeTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | RegularAssetTypeTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | RegularAssetTypeTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | RegularAssetTypeTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | RegularAssetTypeTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | RegularAssetTypeTask->TaskClassification8_Description | string | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTaskResourceRuleLinks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Resource Rule Link resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskResourceRuleLink->Id | integer | int64 |\r\n| regularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceResourceCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code | string | |\r\n| regularAssetTypeTaskResourceResourceDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Description | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskComponentId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskResourceRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskResourceRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskResourceRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskResourceRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskResourceRuleLinksRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskResourceRuleLinksRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTaskSpareRuleLinks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Spare Rule Link resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSpareRuleLink->Id | integer | int64 |\r\n| regularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareMaterialMasterId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareMaterialMasterCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Code | string | |\r\n| regularAssetTypeTaskSpareMaterialMasterDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Description | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskComponentId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskSpareRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskSpareRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskSpareRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskSpareRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskSpareRuleLinksRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskSpareRuleLinksRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTaskSpares/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Spare resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTypeTaskSpare->CostElement_Description | string | |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetTreeRegularAssetTypeTaskSparesRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskSparesRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentId}/RegularAssetTypeTaskSuppressedTasks": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Suppressed Task resources beneath the parent tree node.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskSuppressedTask->IsInherited | boolean | |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| suppressedTaskAlternativeDescription | RegularAssetTypeTaskSuppressedTask->SuppressedTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSuppressedTask->IsActive | boolean | |\r\n", "operationId": "GetTreeRegularAssetTypeTaskSuppressedTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "type": "boolean", "name": "showDeletedConfirmed", "in": "query", "description": "Include records with a DeletedConfirmed development status (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Type Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTypes/Tree/{parentNodeType}/{parentIds}/RegularAssetTypeTaskSuppressedTasks/Recursive": { "get": { "tags": [ "Asset Type Tree" ], "summary": "Get a collection of Regular Asset Type Task Spare resources beneath the parent tree node and all of its child nodes.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskSuppressedTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeTreePathItems | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_AssetType_TreePathItems | array | array |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentTreePathItems | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Component_TreePathItems | array | array |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| permissionTreeId | RegularAssetTypeTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskSuppressedTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskSuppressedTask->PermissionTree_Description | string | |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n", "operationId": "GetTreeRegularAssetTypeTaskSuppressedTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, RegularAssetTypeTasks]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "array", "name": "parentIds", "in": "path", "required": true, "description": "Comma separated list of Parent Id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTypeTaskSuppressedTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/{id}": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Get a Auxiliary Asset Type 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| developmentStatus | AuxiliaryAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTask->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTask->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTask->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->SequenceNumber | integer | int32 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTypeTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTask->PermissionTree_Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| assetTypeId | AuxiliaryAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AuxiliaryAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | AuxiliaryAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeRecordType | AuxiliaryAssetTypeTask->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathId | AuxiliaryAssetTypeTask->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | AuxiliaryAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| auxiliaryTaskType | AuxiliaryAssetTypeTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | AuxiliaryAssetTypeTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTypeTask->Component_Description | string | |\r\n| componentQuantity | AuxiliaryAssetTypeTask->Component_Quantity | integer | int32 |\r\n| componentRecordType | AuxiliaryAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetTypeId | AuxiliaryAssetTypeTask->Component_AssetType_Id | integer | int64 |\r\n| componentAssetTypeCode | AuxiliaryAssetTypeTask->Component_AssetType_Code | string | |\r\n| componentAssetTypeDescription | AuxiliaryAssetTypeTask->Component_AssetType_Description | string | |\r\n| componentAssetTypeRecordType | AuxiliaryAssetTypeTask->Component_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathId | AuxiliaryAssetTypeTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | AuxiliaryAssetTypeTask->Component_TreePathItems | array | array |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| downtimePerUnit | AuxiliaryAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTypeTask->DurationPerUnit | string | duration |\r\n| inheritedFromId | AuxiliaryAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | AuxiliaryAssetTypeTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | AuxiliaryAssetTypeTask->InheritedFrom_Description | string | |\r\n| isHistorical | AuxiliaryAssetTypeTask->IsHistorical | boolean | |\r\n| isSuppressed | AuxiliaryAssetTypeTask->IsSuppressed | boolean | |\r\n| isSuppressor | AuxiliaryAssetTypeTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | AuxiliaryAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTypeTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| responsibleSectionId | AuxiliaryAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | AuxiliaryAssetTypeTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | AuxiliaryAssetTypeTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceContactDetailId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | AuxiliaryAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | AuxiliaryAssetTypeTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | AuxiliaryAssetTypeTask->ResponsibleTrade_Description | string | |\r\n| totalDowntime | AuxiliaryAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTypeTask->TotalDuration | string | duration |\r\n", "operationId": "GetAuxiliaryAssetTypeTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Type Task", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Update an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| alternativeDescription | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n| labourDurationCalculationType | AuxiliaryAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTypeTask->Notes | string | |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | AuxiliaryAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->SequenceNumber | integer | int32 |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTypeTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTypeTask->TotalDuration | string | duration |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| componentId | Min Value | > 0| |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n\r\n", "operationId": "UpdateAuxiliaryAssetTypeTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Get a collection of Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| permissionTreeCode | AuxiliaryAssetTypeTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTask->PermissionTree_Description | string | |\r\n| isInherited | AuxiliaryAssetTypeTask->IsInherited | boolean | |\r\n| inheritedFromId | AuxiliaryAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AuxiliaryAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| assetTypeId | AuxiliaryAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AuxiliaryAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | AuxiliaryAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeTreePathItems | AuxiliaryAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentCode | AuxiliaryAssetTypeTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTypeTask->Component_Description | string | |\r\n| componentTreePathItems | AuxiliaryAssetTypeTask->Component_TreePathItems | array | array |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Create a new Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| assetTypeId | AuxiliaryAssetTypeTask->AssetType_Id | integer | int64 |\r\n| auxiliaryTaskType | AuxiliaryAssetTypeTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| labourDurationCalculationType | AuxiliaryAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTypeTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | AuxiliaryAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->SequenceNumber | integer | int32 |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTypeTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTypeTask->TotalDuration | string | duration |\r\n\r\n#### Business 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 | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\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| componentId | Min Value | > 0| |\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| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| autoCalculateTotalDowntime | Required | True | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Required | True | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDuration | Required | True | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n\r\n", "operationId": "CreateAuxiliaryAssetTypeTask", "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/CreateAuxiliaryAssetTypeTaskResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/Lookups/LookupAuxiliaryAssetTypeTaskAssetType": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Lookup the Auxiliary Asset Type Task for the Auxiliary Asset Type 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 | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAuxiliaryAssetTypeTaskAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTypeTaskAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Lookups/LookupAuxiliaryAssetTypeTaskChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Lookup the permission set for changing the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Lookups/LookupAuxiliaryAssetTypeTaskComponent": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Lookup the Auxiliary Asset Type Task for the Auxiliary Asset Type 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 | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| quantity | AssetTypeComponent->Quantity | integer | int32 |\r\n| recordType | AssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAuxiliaryAssetTypeTaskComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTypeTaskComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Lookups/LookupAuxiliaryAssetTypeTaskInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Lookup the permission set for creating the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Lookups/LookupAuxiliaryAssetTypeTaskResponsibleSection": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Lookup the Section for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResponsibleSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResponsibleSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Lookups/LookupAuxiliaryAssetTypeTaskResponsibleStaffMemberResource": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Lookup the Resource for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResponsibleStaffMemberResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Lookups/LookupAuxiliaryAssetTypeTaskResponsibleTrade": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Lookup the Trade for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResponsibleTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResponsibleTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Get a collection of Auxiliary Asset Type 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| developmentStatus | AuxiliaryAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTask->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTask->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTask->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->SequenceNumber | integer | int32 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTypeTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTask->PermissionTree_Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| assetTypeId | AuxiliaryAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AuxiliaryAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | AuxiliaryAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeRecordType | AuxiliaryAssetTypeTask->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathId | AuxiliaryAssetTypeTask->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | AuxiliaryAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| auxiliaryTaskType | AuxiliaryAssetTypeTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | AuxiliaryAssetTypeTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTypeTask->Component_Description | string | |\r\n| componentQuantity | AuxiliaryAssetTypeTask->Component_Quantity | integer | int32 |\r\n| componentRecordType | AuxiliaryAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetTypeId | AuxiliaryAssetTypeTask->Component_AssetType_Id | integer | int64 |\r\n| componentAssetTypeCode | AuxiliaryAssetTypeTask->Component_AssetType_Code | string | |\r\n| componentAssetTypeDescription | AuxiliaryAssetTypeTask->Component_AssetType_Description | string | |\r\n| componentAssetTypeRecordType | AuxiliaryAssetTypeTask->Component_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathId | AuxiliaryAssetTypeTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | AuxiliaryAssetTypeTask->Component_TreePathItems | array | array |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| downtimePerUnit | AuxiliaryAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTypeTask->DurationPerUnit | string | duration |\r\n| inheritedFromId | AuxiliaryAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | AuxiliaryAssetTypeTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | AuxiliaryAssetTypeTask->InheritedFrom_Description | string | |\r\n| isHistorical | AuxiliaryAssetTypeTask->IsHistorical | boolean | |\r\n| isSuppressed | AuxiliaryAssetTypeTask->IsSuppressed | boolean | |\r\n| isSuppressor | AuxiliaryAssetTypeTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | AuxiliaryAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTypeTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| responsibleSectionId | AuxiliaryAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | AuxiliaryAssetTypeTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | AuxiliaryAssetTypeTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceContactDetailId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | AuxiliaryAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | AuxiliaryAssetTypeTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | AuxiliaryAssetTypeTask->ResponsibleTrade_Description | string | |\r\n| totalDowntime | AuxiliaryAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTypeTask->TotalDuration | string | duration |\r\n", "operationId": "BatchGetAuxiliaryAssetTypeTask", "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 Auxiliary Asset Type 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 Auxiliary Asset Type Task collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTypeTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Batch": { "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Create a new collection of Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| assetTypeId | AuxiliaryAssetTypeTask->AssetType_Id | integer | int64 |\r\n| auxiliaryTaskType | AuxiliaryAssetTypeTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| labourDurationCalculationType | AuxiliaryAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTypeTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | AuxiliaryAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->SequenceNumber | integer | int32 |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTypeTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTypeTask->TotalDuration | string | duration |\r\n\r\n#### Business 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 | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\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| componentId | Min Value | > 0| |\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| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| autoCalculateTotalDowntime | Required | True | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Required | True | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDuration | Required | True | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n\r\n", "operationId": "BatchCreateAuxiliaryAssetTypeTask", "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/BatchCreateAuxiliaryAssetTypeTaskResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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": [ "Auxiliary Asset Type Task" ], "summary": "Update a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| alternativeDescription | AuxiliaryAssetTypeTask->AlternativeDescription | string | |\r\n| componentId | AuxiliaryAssetTypeTask->Component_Id | integer | int64 |\r\n| labourDurationCalculationType | AuxiliaryAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTypeTask->Notes | string | |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | AuxiliaryAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTypeTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTypeTask->TotalDuration | string | duration |\r\n| sequenceNumber | AuxiliaryAssetTypeTask->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| componentId | Min Value | > 0| |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateTotalDuration | Nullable | False | |\r\n| downtimePerUnit | Min Value | >= 00:00:00| |\r\n| durationPerUnit | Min Value | >= 00:00:00| |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n\r\n", "operationId": "BatchUpdateAuxiliaryAssetTypeTask", "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/BatchUpdateAuxiliaryAssetTypeTaskResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Type Task resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Type Task resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Change the Development Status for the collection of existing Auxiliary Asset Type Task resource id's.", "description": "", "operationId": "BatchChangeAuxiliaryAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Type Task resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Change the Development Status for an existing Auxiliary Asset Type Task resource.", "description": "", "operationId": "ChangeAuxiliaryAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Change the IsActive status for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTask->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": "ChangeAuxiliaryAssetTypeTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/AuxiliaryAssetTypeTasks/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTask->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": "ChangeAuxiliaryAssetTypeTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/AuxiliaryAssetTypeTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Type Task resource.", "description": "", "operationId": "RejectAuxiliaryAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTask->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| 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": "BatchChangeAuxiliaryAssetTypeTaskIsActive", "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/BatchChangeAuxiliaryAssetTypeTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/AuxiliaryAssetTypeTasks/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeAuxiliaryAssetTypeTaskPermissionTree", "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/BatchChangeAuxiliaryAssetTypeTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/AuxiliaryAssetTypeTasks/Resources/{id}": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Get a Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Description | string | |\r\n| developmentStatus | AuxiliaryAssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTaskResource->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTaskResource->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTaskResource->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTaskResource->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTaskResource->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTaskResource->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| createdByUserId | AuxiliaryAssetTypeTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTaskResource->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTaskResource->PermissionTree_Description | string | |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTypeTaskResource->Competency_Description | string | |\r\n| competencyValidityType | AuxiliaryAssetTypeTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskResource->InheritedFrom_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTypeTaskResource->Notes | string | |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| recordType | AuxiliaryAssetTypeTaskResource->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceContactDetailId | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | AuxiliaryAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTypeTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Type Task Resource", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Update an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| notes | AuxiliaryAssetTypeTaskResource->Notes | string | |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | AuxiliaryAssetTypeTaskResource->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| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | Min Value | >= 0| |\r\n| tradeId | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateAuxiliaryAssetTypeTaskResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskResourceResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Get a collection of Auxiliary Asset Type Task Resource resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AuxiliaryAssetTypeTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Description | string | |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTypeTaskResource->Trade_Description | string | |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceDescription | AuxiliaryAssetTypeTaskResource->Resource_Description | string | |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | AuxiliaryAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTypeTaskResource->Competency_Description | string | |\r\n| isInherited | AuxiliaryAssetTypeTaskResource->IsInherited | boolean | |\r\n| notes | AuxiliaryAssetTypeTaskResource->Notes | string | |\r\n| isActive | AuxiliaryAssetTypeTaskResource->IsActive | boolean | |\r\n| developmentStatus | AuxiliaryAssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskResourceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task Resource collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Create a new Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n| notes | AuxiliaryAssetTypeTaskResource->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | AuxiliaryAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | AuxiliaryAssetTypeTaskResource->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| auxiliaryAssetTypeTaskId | Required | True | |\r\n| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | 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| quantity | Required | True | |\r\n| quantity | Nullable | False | |\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": "CreateAuxiliaryAssetTypeTaskResource", "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/CreateAuxiliaryAssetTypeTaskResourceResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/{id}/Resources": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Get a collection of Auxiliary Asset Type Task Resource resources for the Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTypeTaskResource->Competency_Description | string | |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTypeTaskResource->Trade_Description | string | |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskResourceForAuxiliaryAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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 Auxiliary Asset Type Task Resource collection", "schema": { "$ref": "#/definitions/GetResourceForAuxiliaryAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceAuxiliaryAssetTypeTask": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the Auxiliary Asset Type Task Resource for the Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTypeTaskResourceAuxiliaryAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTypeTaskResourceTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the permission set for changing the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResourceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceCompetency": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the Competency for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResourceCompetency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceCompetencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the permission set for creating the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResourceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceResource": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the Resource for the Auxiliary Asset Type Task Resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| resourceType | Resource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupAuxiliaryAssetTypeTaskResourceResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceSection": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the Section for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResourceSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceTrade": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the Trade for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResourceTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Lookups/LookupAuxiliaryAssetTypeTaskResourceUnitOfMeasurement": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Lookup the for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskResourceUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Get a collection of Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Description | string | |\r\n| developmentStatus | AuxiliaryAssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTaskResource->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTaskResource->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTaskResource->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTaskResource->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTaskResource->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTaskResource->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| createdByUserId | AuxiliaryAssetTypeTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTaskResource->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTaskResource->PermissionTree_Description | string | |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTypeTaskResource->Competency_Description | string | |\r\n| competencyValidityType | AuxiliaryAssetTypeTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskResource->InheritedFrom_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTypeTaskResource->Notes | string | |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| recordType | AuxiliaryAssetTypeTaskResource->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceContactDetailId | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | AuxiliaryAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTypeTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n", "operationId": "BatchGetAuxiliaryAssetTypeTaskResource", "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 Auxiliary Asset Type 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 Auxiliary Asset Type Task Resource collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTypeTaskResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Resources/Batch": { "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Create a new collection of Auxiliary Asset Type 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| permissionTreeId | AuxiliaryAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n| notes | AuxiliaryAssetTypeTaskResource->Notes | string | |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | AuxiliaryAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | AuxiliaryAssetTypeTaskResource->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | Required | True | |\r\n| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | Min Value | >= 0| |\r\n| usage | System Generated | true | If no value specified |\r\n| usage | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\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": "BatchCreateAuxiliaryAssetTypeTaskResource", "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/BatchCreateAuxiliaryAssetTypeTaskResourceResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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": [ "Auxiliary Asset Type Task Resource" ], "summary": "Update a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| notes | AuxiliaryAssetTypeTaskResource->Notes | string | |\r\n| sectionId | AuxiliaryAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| tradeId | AuxiliaryAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | AuxiliaryAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | AuxiliaryAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | AuxiliaryAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| usage | AuxiliaryAssetTypeTaskResource->Usage | object | composite |\r\n| quantity | AuxiliaryAssetTypeTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | AuxiliaryAssetTypeTaskResource->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| id | Min Value | >= 0| |\r\n| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | Min Value | >= 0| |\r\n| tradeId | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateAuxiliaryAssetTypeTaskResource", "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/BatchUpdateAuxiliaryAssetTypeTaskResourceResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Type Task Resource resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Type Task Resource resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Change the Development Status for the collection of existing Auxiliary Asset Type Task Resource resource id's.", "description": "", "operationId": "BatchChangeAuxiliaryAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Type Task Resource resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Change the Development Status for an existing Auxiliary Asset Type Task Resource resource.", "description": "", "operationId": "ChangeAuxiliaryAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Change the IsActive status for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTaskResource->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": "ChangeAuxiliaryAssetTypeTaskResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskResourceIsActiveResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/Resources/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskResource->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": "ChangeAuxiliaryAssetTypeTaskResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskResourcePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/AuxiliaryAssetTypeTasks/Resources/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Type Task Resource resource.", "description": "", "operationId": "RejectAuxiliaryAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Resources/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTaskResource->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| 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": "BatchChangeAuxiliaryAssetTypeTaskResourceIsActive", "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/BatchChangeAuxiliaryAssetTypeTaskResourceIsActiveResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/Resources/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task Resource" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskResource->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| id | Min Value | >= 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeAuxiliaryAssetTypeTaskResourcePermissionTree", "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/BatchChangeAuxiliaryAssetTypeTaskResourcePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/AuxiliaryAssetTypeTasks/Spares/{id}": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Get a Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Description | string | |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTaskSpare->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTaskSpare->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTaskSpare->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTaskSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTaskSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTaskSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSpare->SequenceNumber | integer | int32 |\r\n| createdByUserId | AuxiliaryAssetTypeTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTaskSpare->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTaskSpare->PermissionTree_Description | string | |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTypeTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| isHistorical | AuxiliaryAssetTypeTaskSpare->IsHistorical | boolean | |\r\n| materialMasterId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | AuxiliaryAssetTypeTaskSpare->Notes | string | |\r\n| preferredMaterialMasterId | AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| preferredMaterialMasterCode | AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Code | string | |\r\n| preferredMaterialMasterDescription | AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Description | string | |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n| recordType | AuxiliaryAssetTypeTaskSpare->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Type Task Spare", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Update an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTypeTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSpare->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateAuxiliaryAssetTypeTaskSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskSpareResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Get a collection of Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| isInherited | AuxiliaryAssetTypeTaskSpare->IsInherited | boolean | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| materialMasterId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTypeTaskSpare->CostElement_Description | string | |\r\n| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Description | string | |\r\n| auxiliaryAssetTypeTaskAssetTypeTreePathItems | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_AssetType_TreePathItems | array | array |\r\n| auxiliaryAssetTypeTaskComponentTreePathItems | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Component_TreePathItems | array | array |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task Spare collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Create a new Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| materialMasterId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTypeTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSpare->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| auxiliaryAssetTypeTaskId | Required | True | |\r\n| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | 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\r\n", "operationId": "CreateAuxiliaryAssetTypeTaskSpare", "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/CreateAuxiliaryAssetTypeTaskSpareResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/{id}/Spares": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Get a collection of Auxiliary Asset Type Task Spare resources for the Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| materialMasterId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTypeTaskSpare->CostElement_Description | string | |\r\n| isInherited | AuxiliaryAssetTypeTaskSpare->IsInherited | boolean | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskSpareForAuxiliaryAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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 Auxiliary Asset Type Task Spare collection", "schema": { "$ref": "#/definitions/GetSpareForAuxiliaryAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Spares/Lookups/LookupAuxiliaryAssetTypeTaskSpareAuxiliaryAssetTypeTask": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Lookup the Auxiliary Asset Type Task Spare for the Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTypeTaskSpareAuxiliaryAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTypeTaskSpareTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Spares/Lookups/LookupAuxiliaryAssetTypeTaskSpareChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Lookup the permission set for changing the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Spares/Lookups/LookupAuxiliaryAssetTypeTaskSpareCostElement": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Lookup the Cost Element for the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskSpareCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskSpareCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Spares/Lookups/LookupAuxiliaryAssetTypeTaskSpareInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Lookup the permission set for creating the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Spares/Lookups/LookupAuxiliaryAssetTypeTaskSpareMaterialMaster": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Lookup the Material Master for the Auxiliary Asset Type 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| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTypeTaskSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Spares/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Get a collection of Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Description | string | |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTaskSpare->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTaskSpare->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTaskSpare->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTaskSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTaskSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTaskSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSpare->SequenceNumber | integer | int32 |\r\n| createdByUserId | AuxiliaryAssetTypeTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTaskSpare->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTaskSpare->PermissionTree_Description | string | |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTypeTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| isHistorical | AuxiliaryAssetTypeTaskSpare->IsHistorical | boolean | |\r\n| materialMasterId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | AuxiliaryAssetTypeTaskSpare->Notes | string | |\r\n| preferredMaterialMasterId | AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| preferredMaterialMasterCode | AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Code | string | |\r\n| preferredMaterialMasterDescription | AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Description | string | |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n| recordType | AuxiliaryAssetTypeTaskSpare->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "BatchGetAuxiliaryAssetTypeTaskSpare", "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 Auxiliary Asset Type 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 Auxiliary Asset Type Task Spare collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTypeTaskSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/Spares/Batch": { "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Create a new collection of Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| materialMasterId | AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTypeTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSpare->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| auxiliaryAssetTypeTaskId | Required | True | |\r\n| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | 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\r\n", "operationId": "BatchCreateAuxiliaryAssetTypeTaskSpare", "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/BatchCreateAuxiliaryAssetTypeTaskSpareResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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": [ "Auxiliary Asset Type Task Spare" ], "summary": "Update a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| costElementId | AuxiliaryAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTypeTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTypeTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSpare->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateAuxiliaryAssetTypeTaskSpare", "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/BatchUpdateAuxiliaryAssetTypeTaskSpareResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Type Task Spare resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Type Task Spare resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Change the Development Status for the collection of existing Auxiliary Asset Type Task Spare resource id's.", "description": "", "operationId": "BatchChangeAuxiliaryAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Type Task Spare resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Change the Development Status for an existing Auxiliary Asset Type Task Spare resource.", "description": "", "operationId": "ChangeAuxiliaryAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Change the IsActive status for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTaskSpare->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": "ChangeAuxiliaryAssetTypeTaskSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSpareIsActiveResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSpare->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": "ChangeAuxiliaryAssetTypeTaskSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/AuxiliaryAssetTypeTasks/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Type Task Spare resource.", "description": "", "operationId": "RejectAuxiliaryAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/Spares/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTaskSpare->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| 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": "BatchChangeAuxiliaryAssetTypeTaskSpareIsActive", "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/BatchChangeAuxiliaryAssetTypeTaskSpareIsActiveResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task Spare" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeAuxiliaryAssetTypeTaskSparePermissionTree", "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/BatchChangeAuxiliaryAssetTypeTaskSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/AuxiliaryAssetTypeTasks/SubTasks/{id}": { "get": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Get a Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Description | string | |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTaskSubTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTaskSubTask->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTaskSubTask->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTaskSubTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTaskSubTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTypeTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTaskSubTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Description | string | |\r\n| notes | AuxiliaryAssetTypeTaskSubTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTypeTaskSubTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskSubTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Type Task Sub Task", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskSubTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Update an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| notes | AuxiliaryAssetTypeTaskSubTask->Notes | string | |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "UpdateAuxiliaryAssetTypeTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks": { "get": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Get a collection of Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isInherited | AuxiliaryAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Code | string | |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n", "operationId": "GetAuxiliaryAssetTypeTaskSubTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task Sub Task collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskSubTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Create a new Auxiliary Asset Type 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| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| notes | AuxiliaryAssetTypeTaskSubTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSubTask->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| auxiliaryAssetTypeTaskId | Required | True | |\r\n| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | Min Value | > 0| |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAuxiliaryAssetTypeTaskSubTask", "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/CreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/{id}/SubTasks": { "get": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Get a collection of Auxiliary Asset Type Task Sub Task resources for the Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isInherited | AuxiliaryAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n", "operationId": "GetSubTaskForAuxiliaryAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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 Auxiliary Asset Type Task Sub Task collection", "schema": { "$ref": "#/definitions/GetSubTaskForAuxiliaryAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/SubTasks/Lookups/LookupAuxiliaryAssetTypeTaskSubTaskAuxiliaryAssetTypeTask": { "get": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Lookup the Auxiliary Asset Type Task Sub Task for the Auxiliary Asset Type 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTypeTaskSubTaskAuxiliaryAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTypeTaskSubTaskTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/SubTasks/Lookups/LookupAuxiliaryAssetTypeTaskSubTaskChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Lookup the permission set for changing the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskSubTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/SubTasks/Lookups/LookupAuxiliaryAssetTypeTaskSubTaskInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Lookup the permission set for creating the Auxiliary Asset Type 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": "LookupAuxiliaryAssetTypeTaskSubTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/SubTasks/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Get a collection of Auxiliary Asset Type 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| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryAssetTypeTaskCode | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Code | string | |\r\n| auxiliaryAssetTypeTaskDescription | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Description | string | |\r\n| developmentStatus | AuxiliaryAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | AuxiliaryAssetTypeTaskSubTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTypeTaskSubTask->IsActive | boolean | |\r\n| isBackup | AuxiliaryAssetTypeTaskSubTask->IsBackup | boolean | |\r\n| isInherited | AuxiliaryAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| lastConfirmedOn | AuxiliaryAssetTypeTaskSubTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | AuxiliaryAssetTypeTaskSubTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTypeTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTypeTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTypeTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTypeTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTypeTaskSubTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Description | string | |\r\n| notes | AuxiliaryAssetTypeTaskSubTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTypeTaskSubTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "BatchGetAuxiliaryAssetTypeTaskSubTask", "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 Auxiliary Asset Type 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 Auxiliary Asset Type Task Sub Task collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTypeTaskSubTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTypeTasks/SubTasks/Batch": { "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Create a new collection of Auxiliary Asset Type 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| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| auxiliaryAssetTypeTaskId | AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Id | integer | int64 |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| notes | AuxiliaryAssetTypeTaskSubTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSubTask->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| auxiliaryAssetTypeTaskId | Required | True | |\r\n| auxiliaryAssetTypeTaskId | Nullable | False | |\r\n| auxiliaryAssetTypeTaskId | Min Value | > 0| |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAuxiliaryAssetTypeTaskSubTask", "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/BatchCreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Update a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTypeTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| notes | AuxiliaryAssetTypeTaskSubTask->Notes | string | |\r\n| sequenceNumber | AuxiliaryAssetTypeTaskSubTask->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchUpdateAuxiliaryAssetTypeTaskSubTask", "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/BatchUpdateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest" } }, { "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 - Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Type Task Sub Task resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Type Task Sub Task resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Change the Development Status for the collection of existing Auxiliary Asset Type Task Sub Task resource id's.", "description": "", "operationId": "BatchChangeAuxiliaryAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Type Task Sub Task resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Change the Development Status for an existing Auxiliary Asset Type Task Sub Task resource.", "description": "", "operationId": "ChangeAuxiliaryAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Change the IsActive status for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTaskSubTask->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": "ChangeAuxiliaryAssetTypeTaskSubTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSubTaskIsActiveResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/SubTasks/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSubTask->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": "ChangeAuxiliaryAssetTypeTaskSubTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSubTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/AuxiliaryAssetTypeTasks/SubTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Type Task Sub Task resource.", "description": "", "operationId": "RejectAuxiliaryAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Type 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/AuxiliaryAssetTypeTasks/SubTasks/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTypeTaskSubTask->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| 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": "BatchChangeAuxiliaryAssetTypeTaskSubTaskIsActive", "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/BatchChangeAuxiliaryAssetTypeTaskSubTaskIsActiveResourceActionRequest" } }, { "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/AuxiliaryAssetTypeTasks/SubTasks/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Type Task Sub Task" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset Type 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 | AuxiliaryAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTypeTaskSubTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeAuxiliaryAssetTypeTaskSubTaskPermissionTree", "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/BatchChangeAuxiliaryAssetTypeTaskSubTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/{id}": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Get a In-Place Asset 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| developmentStatus | InPlaceAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| isActive | InPlaceAssetType->IsActive | boolean | |\r\n| isBackup | InPlaceAssetType->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetType->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetType->LastConfirmedOn | string | date-time |\r\n| nearestRegularAssetTypeId | InPlaceAssetType->NearestRegularAssetType_Id | integer | int64 |\r\n| parentAssetTypeId | InPlaceAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | InPlaceAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | InPlaceAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | InPlaceAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| previousDevelopmentStatus | InPlaceAssetType->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetType->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | InPlaceAssetType->RulesLastChangedOn | string | date-time |\r\n| code | InPlaceAssetType->Code | string | |\r\n| createdByUserId | InPlaceAssetType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetType->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetType->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetType->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetType->PermissionTree_Description | string | |\r\n| treePathId | InPlaceAssetType->TreePathId | integer | int64 |\r\n| treePathItems | InPlaceAssetType->TreePathItems | array | array |\r\n| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAssetType->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | InPlaceAssetType->AssetImportance_Code | string | |\r\n| assetImportanceDescription | InPlaceAssetType->AssetImportance_Description | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| inheritedFromId | InPlaceAssetType->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | InPlaceAssetType->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | InPlaceAssetType->InheritedFrom_Description | string | |\r\n| notes | InPlaceAssetType->Notes | string | |\r\n| recordType | InPlaceAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| taskRollUpPointId | InPlaceAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | InPlaceAssetType->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | InPlaceAssetType->TaskRollUpPoint_Description | string | |\r\n", "operationId": "GetInPlaceAssetType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Type", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Type" ], "summary": "Update an existing In-Place Asset 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 | InPlaceAssetType->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetType->SequenceNumber | integer | int32 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| notes | InPlaceAssetType->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 | Read-only | True | InPlaceAssetType->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | InPlaceAssetType->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateInPlaceAssetType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetTypeResourceActionRequest" } }, { "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 - In-Place Asset 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" } } } }, "/Modules/AMPC/InPlaceAssetTypes": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Get a collection of In-Place Asset Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | InPlaceAssetType->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| parentAssetTypeId | InPlaceAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | InPlaceAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | InPlaceAssetType->ParentAssetType_Description | string | |\r\n| rulesLastChangedOn | InPlaceAssetType->RulesLastChangedOn | string | date-time |\r\n| notes | InPlaceAssetType->Notes | string | |\r\n| isActive | InPlaceAssetType->IsActive | boolean | |\r\n| permissionTreeId | InPlaceAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetType->PermissionTree_Description | string | |\r\n| createdOn | InPlaceAssetType->CreatedOn | string | date-time |\r\n| modifiedOn | InPlaceAssetType->ModifiedOn | string | date-time |\r\n| isInherited | InPlaceAssetType->IsInherited | boolean | |\r\n| treePathItems | InPlaceAssetType->TreePathItems | array | array |\r\n", "operationId": "GetInPlaceAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Type" ], "summary": "Create a new In-Place Asset 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| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| notes | InPlaceAssetType->Notes | string | |\r\n| parentAssetTypeId | InPlaceAssetType->ParentAssetType_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetType->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetType->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| parentAssetTypeId | Required | True | |\r\n| parentAssetTypeId | Nullable | False | |\r\n| parentAssetTypeId | Min Value | >= 1| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAssetType", "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/CreateInPlaceAssetTypeResourceActionRequest" } }, { "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/InPlaceAssetTypes/Lookups/LookupInPlaceAssetTypeAssetImportance": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Lookup the Asset Importance for the In-Place Asset 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 | AssetImportance->Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n", "operationId": "LookupInPlaceAssetTypeAssetImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Importance collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeAssetImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Lookups/LookupInPlaceAssetTypeAssetTypeParent": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Lookup the In-Place Asset Type for the In-Place Asset 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 | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupInPlaceAssetTypeAssetTypeParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Lookups/LookupInPlaceAssetTypeChangePermissionTree": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Lookup the permission set for changing the In-Place Asset 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": "LookupInPlaceAssetTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Lookups/LookupInPlaceAssetTypeInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Lookup the permission set for creating the In-Place Asset 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": "LookupInPlaceAssetTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Lookups/LookupInPlaceRegularAssetTypeTaskRollUpPoint": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Lookup the Task Roll Up Point for the In-Place Asset 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 | TaskRollUpPoint->Id | integer | int64 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n", "operationId": "LookupInPlaceRegularAssetTypeTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceRegularAssetTypeTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Type" ], "summary": "Get a collection of In-Place Asset 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| developmentStatus | InPlaceAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| isActive | InPlaceAssetType->IsActive | boolean | |\r\n| isBackup | InPlaceAssetType->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetType->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetType->LastConfirmedOn | string | date-time |\r\n| nearestRegularAssetTypeId | InPlaceAssetType->NearestRegularAssetType_Id | integer | int64 |\r\n| parentAssetTypeId | InPlaceAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | InPlaceAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | InPlaceAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | InPlaceAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| previousDevelopmentStatus | InPlaceAssetType->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetType->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | InPlaceAssetType->RulesLastChangedOn | string | date-time |\r\n| code | InPlaceAssetType->Code | string | |\r\n| createdByUserId | InPlaceAssetType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetType->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetType->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetType->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetType->PermissionTree_Description | string | |\r\n| treePathId | InPlaceAssetType->TreePathId | integer | int64 |\r\n| treePathItems | InPlaceAssetType->TreePathItems | array | array |\r\n| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAssetType->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | InPlaceAssetType->AssetImportance_Code | string | |\r\n| assetImportanceDescription | InPlaceAssetType->AssetImportance_Description | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| inheritedFromId | InPlaceAssetType->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | InPlaceAssetType->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | InPlaceAssetType->InheritedFrom_Description | string | |\r\n| notes | InPlaceAssetType->Notes | string | |\r\n| recordType | InPlaceAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| taskRollUpPointId | InPlaceAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | InPlaceAssetType->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | InPlaceAssetType->TaskRollUpPoint_Description | string | |\r\n", "operationId": "BatchGetInPlaceAssetType", "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 In-Place Asset 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 In-Place Asset Type collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Batch": { "post": { "tags": [ "In-Place Asset Type" ], "summary": "Create a new collection of In-Place Asset 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| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n| notes | InPlaceAssetType->Notes | string | |\r\n| parentAssetTypeId | InPlaceAssetType->ParentAssetType_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetType->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetType->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| parentAssetTypeId | Required | True | |\r\n| parentAssetTypeId | Nullable | False | |\r\n| parentAssetTypeId | Min Value | >= 1| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetType", "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/BatchCreateInPlaceAssetTypeResourceActionRequest" } }, { "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 - In-Place Asset 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": [ "In-Place Asset Type" ], "summary": "Update a collection of existing In-Place Asset 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 | InPlaceAssetType->Id | integer | int64 |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| sequenceNumber | InPlaceAssetType->SequenceNumber | integer | int32 |\r\n| description | InPlaceAssetType->Description | string | |\r\n| alternativeDescription | InPlaceAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| notes | InPlaceAssetType->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| id | Min Value | > 1| |\r\n| id | Min Value | > 1| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Read-only | True | InPlaceAssetType->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | InPlaceAssetType->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetType", "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/BatchUpdateInPlaceAssetTypeResourceActionRequest" } }, { "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 - In-Place Asset 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" } } } }, "/Modules/AMPC/InPlaceAssetTypes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type" ], "summary": "Accept the Development Status for an existing In-Place Asset Type resource.", "description": "", "operationId": "AcceptInPlaceAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type 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/InPlaceAssetTypes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Type resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type 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/InPlaceAssetTypes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type" ], "summary": "Change the Development Status for the collection of existing In-Place Asset Type resource id's.", "description": "", "operationId": "BatchChangeInPlaceAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type 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/InPlaceAssetTypes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Type resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type 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/InPlaceAssetTypes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type" ], "summary": "Change the Development Status for an existing In-Place Asset Type resource.", "description": "", "operationId": "ChangeInPlaceAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type 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/InPlaceAssetTypes/{id}/Active": { "patch": { "tags": [ "In-Place Asset Type" ], "summary": "Change the IsActive status for an existing In-Place Asset 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 | InPlaceAssetType->Version | integer | int32 |\r\n| isActive | InPlaceAssetType->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": "ChangeInPlaceAssetTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/InPlaceAssetTypes/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type" ], "summary": "Change the PermissionTree for an existing In-Place Asset 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 | InPlaceAssetType->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetType->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": "ChangeInPlaceAssetTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type" ], "summary": "Reject the Development Status for an existing In-Place Asset Type resource.", "description": "", "operationId": "RejectInPlaceAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type 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/InPlaceAssetTypes/Batch/Active": { "patch": { "tags": [ "In-Place Asset Type" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset 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 | InPlaceAssetType->Id | integer | int64 |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| isActive | InPlaceAssetType->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 | > 1| |\r\n| id | Min Value | > 1| |\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": "BatchChangeInPlaceAssetTypeIsActive", "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/BatchChangeInPlaceAssetTypeIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/InPlaceAssetTypes/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset 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 | InPlaceAssetType->Id | integer | int64 |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetType->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| id | Min Value | > 1| |\r\n| id | Min Value | > 1| |\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": "BatchChangeInPlaceAssetTypePermissionTree", "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/BatchChangeInPlaceAssetTypePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/MatchBatch": { "patch": { "tags": [ "In-Place Asset Type" ], "summary": "Update a collection of existing In-Place Asset Type resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| version | InPlaceAssetType->Version | integer | int32 |\r\n| taskRollUpPointId | InPlaceAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| assetImportanceId | InPlaceAssetType->AssetImportance_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 | Min Value | > 1| |\r\n| id | Min Value | > 1| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdateInPlaceAssetType", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateInPlaceAssetTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset 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" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/{id}": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Get a In-Place Asset Type Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeAttribute->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeAttribute->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeAttribute->InPlaceAssetType_Description | string | |\r\n| inheritedFromId | InPlaceAssetTypeAttribute->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | InPlaceAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | InPlaceAssetTypeAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeAttribute->IsInherited | boolean | |\r\n| createdByUserId | InPlaceAssetTypeAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeAttribute->CreatedOn | string | date-time |\r\n| isActive | InPlaceAssetTypeAttribute->IsActive | boolean | |\r\n| modifiedByUserId | InPlaceAssetTypeAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | InPlaceAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetTypeAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetTypeAttribute->PermissionTree_Description | string | |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| id | InPlaceAssetTypeAttribute->Id | integer | int64 |\r\n| attributeId | InPlaceAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | InPlaceAssetTypeAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | InPlaceAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | InPlaceAssetTypeAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | InPlaceAssetTypeAttribute->Notes | string | |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n", "operationId": "GetInPlaceAssetTypeAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Type Attribute", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Update an existing In-Place Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetTypeAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateInPlaceAssetTypeAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetTypeAttributeResourceActionRequest" } }, { "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 - In-Place Asset Type Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/{inPlaceAssetTypeId}/Attributes": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Get a collection of In-Place Asset Type Attribute resources for the In-Place Asset 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 | InPlaceAssetTypeAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeAttribute->IsInherited | boolean | |\r\n| attributeId | InPlaceAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeDataType | InPlaceAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n| notes | InPlaceAssetTypeAttribute->Notes | string | |\r\n| createdOn | InPlaceAssetTypeAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | InPlaceAssetTypeAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetInPlaceAssetTypeAttributeCollectionForInPlaceAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "inPlaceAssetTypeId", "in": "path", "required": true, "description": "In-Place Asset 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 In-Place Asset Type Attribute collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeAttributeCollectionForInPlaceAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Get a collection of In-Place Asset Type Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeAttribute->IsInherited | boolean | |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeAttribute->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeAttribute->InPlaceAssetType_Description | string | |\r\n| attributeId | InPlaceAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeDataType | InPlaceAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n| notes | InPlaceAssetTypeAttribute->Notes | string | |\r\n| createdOn | InPlaceAssetTypeAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | InPlaceAssetTypeAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetInPlaceAssetTypeAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type Attribute collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Create a new In-Place Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeAttribute->InPlaceAssetType_Id | integer | int64 |\r\n| attributeId | InPlaceAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetTypeAttribute->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAssetTypeAttribute", "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/CreateInPlaceAssetTypeAttributeResourceActionRequest" } }, { "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/InPlaceAssetTypes/Attributes/Lookups/LookupInPlaceAssetTypeAttributeAllowedValue": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Lookup the Attribute Allowed Value for the In-Place Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupInPlaceAssetTypeAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/Lookups/LookupInPlaceAssetTypeAttribute": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Lookup the Attribute for the In-Place Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupInPlaceAssetTypeAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/Lookups/LookupInPlaceAssetTypeAttributeChangePermissionTree": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Lookup the permission set for changing the In-Place Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupInPlaceAssetTypeAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/Lookups/LookupInPlaceAssetTypeAttributeInPlaceAssetType": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Lookup the In-Place Asset Type Attribute for the In-Place Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n", "operationId": "LookupInPlaceAssetTypeAttributeInPlaceAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeAttributeRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/Lookups/LookupInPlaceAssetTypeAttributeInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Lookup the permission set for creating the In-Place Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupInPlaceAssetTypeAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Get a collection of In-Place Asset Type Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeAttribute->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeAttribute->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeAttribute->InPlaceAssetType_Description | string | |\r\n| inheritedFromId | InPlaceAssetTypeAttribute->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | InPlaceAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | InPlaceAssetTypeAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeAttribute->IsInherited | boolean | |\r\n| createdByUserId | InPlaceAssetTypeAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeAttribute->CreatedOn | string | date-time |\r\n| isActive | InPlaceAssetTypeAttribute->IsActive | boolean | |\r\n| modifiedByUserId | InPlaceAssetTypeAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | InPlaceAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetTypeAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetTypeAttribute->PermissionTree_Description | string | |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| id | InPlaceAssetTypeAttribute->Id | integer | int64 |\r\n| attributeId | InPlaceAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | InPlaceAssetTypeAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | InPlaceAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | InPlaceAssetTypeAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | InPlaceAssetTypeAttribute->Notes | string | |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n", "operationId": "BatchGetInPlaceAssetTypeAttribute", "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 In-Place Asset Type Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Type Attribute collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetTypeAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/Batch": { "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Create a new collection of In-Place Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeAttribute->InPlaceAssetType_Id | integer | int64 |\r\n| attributeId | InPlaceAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetTypeAttribute->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetTypeAttribute", "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/BatchCreateInPlaceAssetTypeAttributeResourceActionRequest" } }, { "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 - In-Place Asset Type Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Update a collection of existing In-Place Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| value | InPlaceAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetTypeAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetTypeAttribute", "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/BatchUpdateInPlaceAssetTypeAttributeResourceActionRequest" } }, { "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 - In-Place Asset Type Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "In-Place Asset Type Attribute", "description": "", "operationId": "AcceptInPlaceAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Attribute 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/InPlaceAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Type Attribute resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Attribute 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/InPlaceAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Change the Development Status for the collection of existing In-Place Asset Type Attribute resource id's.", "description": "", "operationId": "BatchChangeInPlaceAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Attribute 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/InPlaceAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Type Attribute resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Attribute 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/InPlaceAssetTypes/Attributes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Change the Development Status for an existing In-Place Asset Type Attribute resource.", "description": "", "operationId": "ChangeInPlaceAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Attribute 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/InPlaceAssetTypes/Attributes/{id}/Active": { "patch": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Change the IsActive status for an existing In-Place Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeAttribute->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": "ChangeInPlaceAssetTypeAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeAttributeIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Change the PermissionTree for an existing In-Place Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeAttribute->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": "ChangeInPlaceAssetTypeAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "In-Place Asset Type Attribute", "description": "", "operationId": "RejectInPlaceAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Attribute 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/InPlaceAssetTypes/Attributes/Batch/Active": { "patch": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeAttribute->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": "BatchChangeInPlaceAssetTypeAttributeIsActive", "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/BatchChangeInPlaceAssetTypeAttributeIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type Attribute" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetTypeAttribute->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeAttribute->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": "BatchChangeInPlaceAssetTypeAttributePermissionTree", "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/BatchChangeInPlaceAssetTypeAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/Responsibilities/{id}": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Get a In-Place Asset Type Responsibility 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| developmentStatus | InPlaceAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetTypeResponsibility->Id | integer | int64 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeResponsibility->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeResponsibility->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeResponsibility->InPlaceAssetType_Description | string | |\r\n| isActive | InPlaceAssetTypeResponsibility->IsActive | boolean | |\r\n| isBackup | InPlaceAssetTypeResponsibility->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetTypeResponsibility->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeResponsibility->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeResponsibility->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| createdByUserId | InPlaceAssetTypeResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetTypeResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetTypeResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetTypeResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | InPlaceAssetTypeResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| notes | InPlaceAssetTypeResponsibility->Notes | string | |\r\n| recordType | InPlaceAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | InPlaceAssetTypeResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | InPlaceAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | InPlaceAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | InPlaceAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | InPlaceAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | InPlaceAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | InPlaceAssetTypeResponsibility->Trade_Description | string | |\r\n", "operationId": "GetInPlaceAssetTypeResponsibility", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Type Responsibility", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeResponsibilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Update an existing In-Place Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetTypeResponsibility->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| resourceId | Nullable | False | InPlaceAssetTypeResponsibility->Section_Id eq NULL AND InPlaceAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "UpdateInPlaceAssetTypeResponsibility", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetTypeResponsibilityResourceActionRequest" } }, { "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 - In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Get a collection of In-Place Asset Type Responsibility 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 | InPlaceAssetTypeResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeResponsibility->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeResponsibility->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeResponsibility->InPlaceAssetType_Description | string | |\r\n| isActive | InPlaceAssetTypeResponsibility->IsActive | boolean | |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| recordType | InPlaceAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | InPlaceAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | InPlaceAssetTypeResponsibility->Section_Description | string | |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetTypeResponsibility->Resource_Code | string | |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | InPlaceAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | InPlaceAssetTypeResponsibility->Trade_Description | string | |\r\n| developmentStatus | InPlaceAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeResponsibility->IsInherited | boolean | |\r\n| inheritedFromId | InPlaceAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| notes | InPlaceAssetTypeResponsibility->Notes | string | |\r\n| createdOn | InPlaceAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedOn | InPlaceAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n", "operationId": "GetInPlaceAssetTypeResponsibilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeResponsibilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Create a new In-Place Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeResponsibility->InPlaceAssetType_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetTypeResponsibility->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| resourceId | Nullable | False | InPlaceAssetTypeResponsibility->Section_Id eq NULL AND InPlaceAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "CreateInPlaceAssetTypeResponsibility", "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/CreateInPlaceAssetTypeResponsibilityResourceActionRequest" } }, { "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/InPlaceAssetTypes/{inPlaceAssetTypeId}/Responsibilities": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Get a collection of InPlace Asset Type Responsibility resources for the InPlace Asset 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 | InPlaceAssetTypeResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | InPlaceAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | InPlaceAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | InPlaceAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | InPlaceAssetTypeResponsibility->Trade_Description | string | |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailFirstName | InPlaceAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | InPlaceAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| notes | InPlaceAssetTypeResponsibility->Notes | string | |\r\n| isInherited | InPlaceAssetTypeResponsibility->IsInherited | boolean | |\r\n| developmentStatus | InPlaceAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetInPlaceAssetTypeResponsibilityForInPlaceAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "inPlaceAssetTypeId", "in": "path", "required": true, "description": "In-Place Asset 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 In-Place Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeResponsibilityForInPlaceAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Lookups/LookupInPlaceAssetTypeResponsibilityChangePermissionTree": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Lookup the permission set for changing the In-Place Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetTypeResponsibilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Lookups/LookupInPlaceAssetTypeResponsibilityInPlaceAssetType": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Lookup the In-Place Asset Type for the In-Place Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n", "operationId": "LookupInPlaceAssetTypeResponsibilityInPlaceAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeResponsibilityInPlaceAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Lookups/LookupInPlaceAssetTypeResponsibilityInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Lookup the permission set for creating the In-Place Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetTypeResponsibilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Lookups/LookupInPlaceAssetTypeResponsibilityResource": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Lookup the Resource for the In-Place Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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| sectionCode | Resource->Section_Code | string | |\r\n", "operationId": "LookupInPlaceAssetTypeResponsibilityResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeResponsibilityResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Lookups/LookupInPlaceAssetTypeResponsibilityResourceWithTradeFilter": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Lookup the Resource for the In-Place Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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| sectionId | Resource->Section_Id | integer | int64 |\r\n| sectionCode | Resource->Section_Code | string | |\r\n| idResourceTradeResourceTradeCode | Resource->*Id.ResourceTrade.Resource_Trade_Code | string | |\r\n", "operationId": "LookupInPlaceAssetTypeResponsibilityResourceWithTradeFilter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Lookups/LookupInPlaceAssetTypeResponsibilitySection": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Lookup the Section for the In-Place Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetTypeResponsibilitySection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeResponsibilitySectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Lookups/LookupInPlaceAssetTypeResponsibilityTrade": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Lookup the Trade for the In-Place Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetTypeResponsibilityTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeResponsibilityTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Get a collection of In-Place Asset Type Responsibility 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| developmentStatus | InPlaceAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetTypeResponsibility->Id | integer | int64 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeResponsibility->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeResponsibility->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeResponsibility->InPlaceAssetType_Description | string | |\r\n| isActive | InPlaceAssetTypeResponsibility->IsActive | boolean | |\r\n| isBackup | InPlaceAssetTypeResponsibility->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetTypeResponsibility->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeResponsibility->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeResponsibility->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| createdByUserId | InPlaceAssetTypeResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetTypeResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetTypeResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetTypeResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | InPlaceAssetTypeResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| notes | InPlaceAssetTypeResponsibility->Notes | string | |\r\n| recordType | InPlaceAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | InPlaceAssetTypeResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | InPlaceAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | InPlaceAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | InPlaceAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | InPlaceAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | InPlaceAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | InPlaceAssetTypeResponsibility->Trade_Description | string | |\r\n", "operationId": "BatchGetInPlaceAssetTypeResponsibility", "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 In-Place Asset Type Responsibility 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 In-Place Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetTypeResponsibilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Responsibilities/Batch": { "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Create a new collection of In-Place Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeResponsibility->InPlaceAssetType_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetTypeResponsibility->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| resourceId | Nullable | False | InPlaceAssetTypeResponsibility->Section_Id eq NULL AND InPlaceAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetTypeResponsibility", "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/BatchCreateInPlaceAssetTypeResponsibilityResourceActionRequest" } }, { "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 - In-Place Asset Type Responsibility 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": [ "In-Place Asset Type Responsibility" ], "summary": "Update a collection of existing In-Place Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetTypeResponsibility->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| resourceId | Nullable | False | InPlaceAssetTypeResponsibility->Section_Id eq NULL AND InPlaceAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetTypeResponsibility", "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/BatchUpdateInPlaceAssetTypeResponsibilityResourceActionRequest" } }, { "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 - In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Accept the Development Status for an existing In-Place Asset Type Responsibility resource.", "description": "", "operationId": "AcceptInPlaceAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Change the Development Status for the collection of existing In-Place Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchChangeInPlaceAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Change the Development Status for an existing In-Place Asset Type Responsibility resource.", "description": "", "operationId": "ChangeInPlaceAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities/{id}/Active": { "patch": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Change the IsActive status for an existing In-Place Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeResponsibility->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": "ChangeInPlaceAssetTypeResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeResponsibilityIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/Responsibilities/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Change the PermissionTree for an existing In-Place Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeResponsibility->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": "ChangeInPlaceAssetTypeResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/Responsibilities/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Reject the Development Status for an existing In-Place Asset Type Responsibility resource.", "description": "", "operationId": "RejectInPlaceAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Responsibility 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/InPlaceAssetTypes/Responsibilities/Batch/Active": { "patch": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeResponsibility->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| 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": "BatchChangeInPlaceAssetTypeResponsibilityIsActive", "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/BatchChangeInPlaceAssetTypeResponsibilityIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/Responsibilities/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type Responsibility" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeResponsibility->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangeInPlaceAssetTypeResponsibilityPermissionTree", "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/BatchChangeInPlaceAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/RuleLinks/{id}": { "get": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Get a In-Place Asset Type Rule Link 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| ruleId | InPlaceAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | InPlaceAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | InPlaceAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleText | InPlaceAssetTypeRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| developmentStatus | InPlaceAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetTypeRuleLink->Id | integer | int64 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeRuleLink->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeRuleLink->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeRuleLink->InPlaceAssetType_Description | string | |\r\n| isActive | InPlaceAssetTypeRuleLink->IsActive | boolean | |\r\n| isBackup | InPlaceAssetTypeRuleLink->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetTypeRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n| createdByUserId | InPlaceAssetTypeRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetTypeRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeRuleLink->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| inheritedFromId | InPlaceAssetTypeRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromInPlaceAssetTypeId | InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Id | integer | int64 |\r\n| inheritedFromInPlaceAssetTypeCode | InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Code | string | |\r\n| inheritedFromInPlaceAssetTypeDescription | InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Description | string | |\r\n| inheritedFromRuleId | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleText | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleText | string | |\r\n| inheritedFromRuleRuleCategoryId | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | InPlaceAssetTypeRuleLink->Notes | string | |\r\n", "operationId": "GetInPlaceAssetTypeRuleLink", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Rule Link Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Type Rule Link", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeRuleLinkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Update an existing In-Place Asset Type Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| notes | InPlaceAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateInPlaceAssetTypeRuleLink", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetTypeRuleLinkResourceActionRequest" } }, { "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 - In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks": { "get": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Get a collection of In-Place Asset Type Rule Link 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 | InPlaceAssetTypeRuleLink->Id | integer | int64 |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeRuleLink->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeRuleLink->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeRuleLink->InPlaceAssetType_Description | string | |\r\n| ruleId | InPlaceAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | InPlaceAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | InPlaceAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| isActive | InPlaceAssetTypeRuleLink->IsActive | boolean | |\r\n| isInherited | InPlaceAssetTypeRuleLink->IsInherited | boolean | |\r\n| developmentStatus | InPlaceAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetInPlaceAssetTypeRuleLinkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type Rule Link collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeRuleLinkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Create a new In-Place Asset Type Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeRuleLink->InPlaceAssetType_Id | integer | int64 |\r\n| ruleId | InPlaceAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| notes | InPlaceAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| inPlaceAssetTypeId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAssetTypeRuleLink", "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/CreateInPlaceAssetTypeRuleLinkResourceActionRequest" } }, { "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/InPlaceAssetTypes/{id}/RuleLinks": { "get": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Get a collection of In-Place Asset Type Rule Link resources for the In-Place Asset 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 | InPlaceAssetTypeRuleLink->Id | integer | int64 |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| ruleId | InPlaceAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | InPlaceAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | InPlaceAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetInPlaceAssetTypeRuleLinkForInPlaceAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset 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 In-Place Asset Type Rule Link collection", "schema": { "$ref": "#/definitions/GetRuleLinkForInPlaceAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/RuleLinks/Lookups/LookupInPlaceAssetTypeRuleLinkInPlaceAssetType": { "get": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Lookup the In-Place Asset Type Rule Link for the In-Place Asset Type Rule Link.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetType->Id | integer | int64 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n", "operationId": "LookupInPlaceAssetTypeRuleLinkInPlaceAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeRuleLinkTaskInPlaceAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/RuleLinks/Lookups/LookupInPlaceAssetTypeRuleLinkRule": { "get": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Lookup the Rule for the In-Place Asset Type Rule Link.", "description": "### Response Body\r\n#### Payload\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| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n", "operationId": "LookupInPlaceAssetTypeRuleLinkRule", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeRuleLinkRuleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/RuleLinks/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Get a collection of In-Place Asset Type Rule Link 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| ruleId | InPlaceAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | InPlaceAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | InPlaceAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleText | InPlaceAssetTypeRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | InPlaceAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| developmentStatus | InPlaceAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetTypeRuleLink->Id | integer | int64 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeRuleLink->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeRuleLink->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeRuleLink->InPlaceAssetType_Description | string | |\r\n| isActive | InPlaceAssetTypeRuleLink->IsActive | boolean | |\r\n| isBackup | InPlaceAssetTypeRuleLink->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetTypeRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n| createdByUserId | InPlaceAssetTypeRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetTypeRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeRuleLink->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| inheritedFromId | InPlaceAssetTypeRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromInPlaceAssetTypeId | InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Id | integer | int64 |\r\n| inheritedFromInPlaceAssetTypeCode | InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Code | string | |\r\n| inheritedFromInPlaceAssetTypeDescription | InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Description | string | |\r\n| inheritedFromRuleId | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleText | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleText | string | |\r\n| inheritedFromRuleRuleCategoryId | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | InPlaceAssetTypeRuleLink->Notes | string | |\r\n", "operationId": "BatchGetInPlaceAssetTypeRuleLink", "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 In-Place Asset Type Rule Link 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 In-Place Asset Type Rule Link collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetTypeRuleLinkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/RuleLinks/Batch": { "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Create a new collection of In-Place Asset Type Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeRuleLink->InPlaceAssetType_Id | integer | int64 |\r\n| ruleId | InPlaceAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| notes | InPlaceAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| inPlaceAssetTypeId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetTypeRuleLink", "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/BatchCreateInPlaceAssetTypeRuleLinkResourceActionRequest" } }, { "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 - In-Place Asset Type Rule Link 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": [ "In-Place Asset Type Rule Link" ], "summary": "Update a collection of existing In-Place Asset Type Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeRuleLink->Id | integer | int64 |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| notes | InPlaceAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | InPlaceAssetTypeRuleLink->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetTypeRuleLink", "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/BatchUpdateInPlaceAssetTypeRuleLinkResourceActionRequest" } }, { "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 - In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Accept the Development Status for an existing In-Place Asset Type Rule Link resource.", "description": "", "operationId": "AcceptInPlaceAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Type Rule Link resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Change the Development Status for the collection of existing In-Place Asset Type Rule Link resource id's.", "description": "", "operationId": "BatchChangeInPlaceAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Type Rule Link resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Change the Development Status for an existing In-Place Asset Type Rule Link resource.", "description": "", "operationId": "ChangeInPlaceAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks/{id}/Active": { "patch": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Change the IsActive status for an existing In-Place Asset Type Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeRuleLink->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": "ChangeInPlaceAssetTypeRuleLinkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeRuleLinkIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/RuleLinks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Reject the Development Status for an existing In-Place Asset Type Rule Link resource.", "description": "", "operationId": "RejectInPlaceAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Rule Link 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/InPlaceAssetTypes/RuleLinks/Batch/Active": { "patch": { "tags": [ "In-Place Asset Type Rule Link" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset Type Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetTypeRuleLink->Id | integer | int64 |\r\n| version | InPlaceAssetTypeRuleLink->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeRuleLink->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| 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": "BatchChangeInPlaceAssetTypeRuleLinkIsActive", "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/BatchChangeInPlaceAssetTypeRuleLinkIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/Spares/{id}": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Get a In-Place Asset Type 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| developmentStatus | InPlaceAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetTypeSpare->Id | integer | int64 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeSpare->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeSpare->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeSpare->InPlaceAssetType_Description | string | |\r\n| isActive | InPlaceAssetTypeSpare->IsActive | boolean | |\r\n| isBackup | InPlaceAssetTypeSpare->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetTypeSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| createdByUserId | InPlaceAssetTypeSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeSpare->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetTypeSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeSpare->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetTypeSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetTypeSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMaterialMasterId | InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| materialMasterId | InPlaceAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetTypeSpare->MaterialMaster_Description | string | |\r\n| notes | InPlaceAssetTypeSpare->Notes | string | |\r\n| recordType | InPlaceAssetTypeSpare->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetInPlaceAssetTypeSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Type Spare", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Update an existing In-Place Asset Type 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 | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetTypeSpare->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| isCritical | Nullable | False | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "UpdateInPlaceAssetTypeSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetTypeSpareResourceActionRequest" } }, { "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 - In-Place Asset Type 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/InPlaceAssetTypes/Spares": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Get a collection of In-Place Asset Type 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 | InPlaceAssetTypeSpare->Id | integer | int64 |\r\n| version | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeSpare->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeSpare->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeSpare->InPlaceAssetType_Description | string | |\r\n| materialMasterId | InPlaceAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetTypeSpare->MaterialMaster_Description | string | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n| developmentStatus | InPlaceAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeSpare->IsInherited | boolean | |\r\n", "operationId": "GetInPlaceAssetTypeSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type Spare collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetTypeSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Create a new In-Place Asset Type 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| inPlaceAssetTypeId | InPlaceAssetTypeSpare->InPlaceAssetType_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | InPlaceAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetTypeSpare->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| inPlaceAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| isCritical | Required | True | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Required | True | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAssetTypeSpare", "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/CreateInPlaceAssetTypeSpareResourceActionRequest" } }, { "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/InPlaceAssetTypes/{id}/Spares": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Get a collection of Spare resources for the InPlace Asset 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 | InPlaceAssetTypeSpare->Id | integer | int64 |\r\n| version | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| materialMasterId | InPlaceAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetTypeSpare->MaterialMaster_Description | string | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| developmentStatus | InPlaceAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | InPlaceAssetTypeSpare->IsInherited | boolean | |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n", "operationId": "GetInPlaceAssetTypeSpareForInPlaceAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset 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 In-Place Asset Type Spare collection", "schema": { "$ref": "#/definitions/GetSpareForInPlaceAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Spares/Lookups/LookupInPlaceAssetTypeSpareChangePermissionTree": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Lookup the permission set for changing the In-Place Asset Type 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": "LookupInPlaceAssetTypeSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Spares/Lookups/LookupInPlaceAssetTypeSpareInPlaceAssetType": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Lookup the In-Place Asset Type for the In-Place Asset Type 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 | InPlaceAssetType->Id | integer | int64 |\r\n| code | InPlaceAssetType->Code | string | |\r\n| description | InPlaceAssetType->Description | string | |\r\n", "operationId": "LookupInPlaceAssetTypeSpareInPlaceAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Type collection", "schema": { "$ref": "#/definitions/InPlaceAssetTypeSpareInPlaceAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Spares/Lookups/LookupInPlaceAssetTypeSpareInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Lookup the permission set for creating the In-Place Asset Type 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": "LookupInPlaceAssetTypeSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Spares/Lookups/LookupInPlaceAssetTypeSpareMaterialMaster": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Lookup the Material Master for the In-Place Asset Type 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": "LookupInPlaceAssetTypeSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetTypeSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Spares/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Get a collection of In-Place Asset Type 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| developmentStatus | InPlaceAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | InPlaceAssetTypeSpare->Id | integer | int64 |\r\n| inPlaceAssetTypeId | InPlaceAssetTypeSpare->InPlaceAssetType_Id | integer | int64 |\r\n| inPlaceAssetTypeCode | InPlaceAssetTypeSpare->InPlaceAssetType_Code | string | |\r\n| inPlaceAssetTypeDescription | InPlaceAssetTypeSpare->InPlaceAssetType_Description | string | |\r\n| isActive | InPlaceAssetTypeSpare->IsActive | boolean | |\r\n| isBackup | InPlaceAssetTypeSpare->IsBackup | boolean | |\r\n| isInherited | InPlaceAssetTypeSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAssetTypeSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | InPlaceAssetTypeSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | InPlaceAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| createdByUserId | InPlaceAssetTypeSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetTypeSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetTypeSpare->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetTypeSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetTypeSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetTypeSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetTypeSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetTypeSpare->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetTypeSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetTypeSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMaterialMasterId | InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| materialMasterId | InPlaceAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetTypeSpare->MaterialMaster_Description | string | |\r\n| notes | InPlaceAssetTypeSpare->Notes | string | |\r\n| recordType | InPlaceAssetTypeSpare->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "BatchGetInPlaceAssetTypeSpare", "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 In-Place Asset Type 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 In-Place Asset Type Spare collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetTypeSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssetTypes/Spares/Batch": { "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Create a new collection of In-Place Asset Type 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| inPlaceAssetTypeId | InPlaceAssetTypeSpare->InPlaceAssetType_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | InPlaceAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetTypeSpare->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| inPlaceAssetTypeId | Required | True | |\r\n| inPlaceAssetTypeId | Nullable | False | |\r\n| inPlaceAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| isCritical | Required | True | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Required | True | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetTypeSpare", "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/BatchCreateInPlaceAssetTypeSpareResourceActionRequest" } }, { "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 - In-Place Asset Type 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": [ "In-Place Asset Type Spare" ], "summary": "Update a collection of existing In-Place Asset Type 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 | InPlaceAssetTypeSpare->Id | integer | int64 |\r\n| version | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetTypeSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetTypeSpare", "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/BatchUpdateInPlaceAssetTypeSpareResourceActionRequest" } }, { "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 - In-Place Asset Type 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/InPlaceAssetTypes/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Accept the Development Status for an existing In-Place Asset Type Spare resource.", "description": "", "operationId": "AcceptInPlaceAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type 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/InPlaceAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Type Spare resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type 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/InPlaceAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Change the Development Status for the collection of existing In-Place Asset Type Spare resource id's.", "description": "", "operationId": "BatchChangeInPlaceAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type 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/InPlaceAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Type Spare resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Type 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/InPlaceAssetTypes/Spares/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Change the Development Status for an existing In-Place Asset Type Spare resource.", "description": "", "operationId": "ChangeInPlaceAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type 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/InPlaceAssetTypes/Spares/{id}/Active": { "patch": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Change the IsActive status for an existing In-Place Asset Type 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 | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeSpare->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": "ChangeInPlaceAssetTypeSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeSpareIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/Spares/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Change the PermissionTree for an existing In-Place Asset Type 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 | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeSpare->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": "ChangeInPlaceAssetTypeSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetTypeSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/InPlaceAssetTypes/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Reject the Development Status for an existing In-Place Asset Type Spare resource.", "description": "", "operationId": "RejectInPlaceAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Type 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/InPlaceAssetTypes/Spares/Batch/Active": { "patch": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset Type 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 | InPlaceAssetTypeSpare->Id | integer | int64 |\r\n| version | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| isActive | InPlaceAssetTypeSpare->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| 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": "BatchChangeInPlaceAssetTypeSpareIsActive", "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/BatchChangeInPlaceAssetTypeSpareIsActiveResourceActionRequest" } }, { "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/InPlaceAssetTypes/Spares/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset Type Spare" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset Type 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 | InPlaceAssetTypeSpare->Id | integer | int64 |\r\n| version | InPlaceAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetTypeSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangeInPlaceAssetTypeSparePermissionTree", "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/BatchChangeInPlaceAssetTypeSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/{id}": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Get a Placeholder Asset 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| developmentStatus | PlaceholderAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| isActive | PlaceholderAssetType->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetType->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetType->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetType->LastConfirmedOn | string | date-time |\r\n| nearestRegularAssetTypeId | PlaceholderAssetType->NearestRegularAssetType_Id | integer | int64 |\r\n| parentAssetTypeId | PlaceholderAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | PlaceholderAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | PlaceholderAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | PlaceholderAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| previousDevelopmentStatus | PlaceholderAssetType->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetType->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | PlaceholderAssetType->RulesLastChangedOn | string | date-time |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| createdByUserId | PlaceholderAssetType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetType->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetType->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetType->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetType->PermissionTree_Description | string | |\r\n| treePathId | PlaceholderAssetType->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAssetType->TreePathItems | array | array |\r\n| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetType->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetType->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetType->AssetImportance_Description | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| inheritedFromId | PlaceholderAssetType->InheritedFrom_Id | integer | int64 |\r\n| linkedToAssetTypeId | PlaceholderAssetType->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetType->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetType->LinkedToAssetType_Description | string | |\r\n| notes | PlaceholderAssetType->Notes | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetType->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetType->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetType->PlaceholderForAssetType_Description | string | |\r\n| recordType | PlaceholderAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| taskRollUpPointId | PlaceholderAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | PlaceholderAssetType->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | PlaceholderAssetType->TaskRollUpPoint_Description | string | |\r\n", "operationId": "GetPlaceholderAssetType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetType->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetType->SequenceNumber | integer | int32 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| notes | PlaceholderAssetType->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 | Read-only | True | PlaceholderAssetType->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | PlaceholderAssetType->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "UpdatePlaceholderAssetType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeResourceActionRequest" } }, { "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 - Placeholder Asset 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" } } } }, "/Modules/AMPC/PlaceholderAssetTypes": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Get a collection of Placeholder Asset Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| sequenceNumber | PlaceholderAssetType->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| placeholderForAssetTypeId | PlaceholderAssetType->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetType->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetType->PlaceholderForAssetType_Description | string | |\r\n| linkedToAssetTypeId | PlaceholderAssetType->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetType->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetType->LinkedToAssetType_Description | string | |\r\n| parentAssetTypeId | PlaceholderAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | PlaceholderAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | PlaceholderAssetType->ParentAssetType_Description | string | |\r\n| rulesLastChangedOn | PlaceholderAssetType->RulesLastChangedOn | string | date-time |\r\n| isInherited | PlaceholderAssetType->IsInherited | boolean | |\r\n| inheritedFromId | PlaceholderAssetType->InheritedFrom_Id | integer | int64 |\r\n| notes | PlaceholderAssetType->Notes | string | |\r\n| permissionTreeId | PlaceholderAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetType->PermissionTree_Description | string | |\r\n| isActive | PlaceholderAssetType->IsActive | boolean | |\r\n| createdOn | PlaceholderAssetType->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetType->ModifiedOn | string | date-time |\r\n| treePathItems | PlaceholderAssetType->TreePathItems | array | array |\r\n", "operationId": "GetPlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Create a new Placeholder Asset 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| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| notes | PlaceholderAssetType->Notes | string | |\r\n| permissionTreeId | PlaceholderAssetType->PermissionTree_Id | integer | int64 |\r\n| parentAssetTypeId | PlaceholderAssetType->ParentAssetType_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetType->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| parentAssetTypeId | Required | True | |\r\n| parentAssetTypeId | Nullable | False | |\r\n| parentAssetTypeId | Min Value | >= 1| |\r\n\r\n", "operationId": "CreatePlaceholderAssetType", "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/CreatePlaceholderAssetTypeResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Lookups/LookupPlaceholderAssetTypeAssetImportance": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Lookup the Asset Importance for the Placeholder Asset 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 | AssetImportance->Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeAssetImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Importance collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeAssetImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Lookups/LookupPlaceholderAssetTypeAssetTypeParent": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Lookup the Placeholder Asset Type for the Placeholder Asset 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 | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupPlaceholderAssetTypeAssetTypeParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeAssetTypeParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Lookups/LookupPlaceholderAssetTypeChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Lookups/LookupPlaceholderAssetTypeInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Lookups/LookupPlaceholderAssetTypeLinkedAssetType": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset 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 | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeLinkedAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeLinkedAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Lookups/LookupPlaceholderAssetTypeRegularAssetType": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset 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 | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Lookups/LookupPlaceholderRegularAssetTypeTaskRollUpPoint": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Lookup the Task Roll Up Point for the Placeholder Asset 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 | TaskRollUpPoint->Id | integer | int64 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n", "operationId": "LookupPlaceholderRegularAssetTypeTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderRegularAssetTypeTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type" ], "summary": "Get a collection of Placeholder Asset 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| developmentStatus | PlaceholderAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| isActive | PlaceholderAssetType->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetType->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetType->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetType->LastConfirmedOn | string | date-time |\r\n| nearestRegularAssetTypeId | PlaceholderAssetType->NearestRegularAssetType_Id | integer | int64 |\r\n| parentAssetTypeId | PlaceholderAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | PlaceholderAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | PlaceholderAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | PlaceholderAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| previousDevelopmentStatus | PlaceholderAssetType->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetType->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | PlaceholderAssetType->RulesLastChangedOn | string | date-time |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| createdByUserId | PlaceholderAssetType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetType->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetType->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetType->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetType->PermissionTree_Description | string | |\r\n| treePathId | PlaceholderAssetType->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAssetType->TreePathItems | array | array |\r\n| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetType->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetType->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetType->AssetImportance_Description | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| inheritedFromId | PlaceholderAssetType->InheritedFrom_Id | integer | int64 |\r\n| linkedToAssetTypeId | PlaceholderAssetType->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetType->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetType->LinkedToAssetType_Description | string | |\r\n| notes | PlaceholderAssetType->Notes | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetType->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetType->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetType->PlaceholderForAssetType_Description | string | |\r\n| recordType | PlaceholderAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| taskRollUpPointId | PlaceholderAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | PlaceholderAssetType->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | PlaceholderAssetType->TaskRollUpPoint_Description | string | |\r\n", "operationId": "BatchGetPlaceholderAssetType", "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 Placeholder Asset 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 Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Batch": { "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Create a new collection of Placeholder Asset 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| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| notes | PlaceholderAssetType->Notes | string | |\r\n| permissionTreeId | PlaceholderAssetType->PermissionTree_Id | integer | int64 |\r\n| parentAssetTypeId | PlaceholderAssetType->ParentAssetType_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetType->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| parentAssetTypeId | Required | True | |\r\n| parentAssetTypeId | Nullable | False | |\r\n| parentAssetTypeId | Min Value | >= 1| |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetType", "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/BatchCreatePlaceholderAssetTypeResourceActionRequest" } }, { "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 - Placeholder Asset 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": [ "Placeholder Asset Type" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetType->Id | integer | int64 |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| sequenceNumber | PlaceholderAssetType->SequenceNumber | integer | int32 |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| alternativeDescription | PlaceholderAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| notes | PlaceholderAssetType->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| id | Min Value | > 1| |\r\n| id | Min Value | > 1| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Read-only | True | PlaceholderAssetType->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | PlaceholderAssetType->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetType", "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/BatchUpdatePlaceholderAssetTypeResourceActionRequest" } }, { "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 - Placeholder Asset 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" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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/PlaceholderAssetTypes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type 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/PlaceholderAssetTypes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type 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/PlaceholderAssetTypes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type 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/PlaceholderAssetTypes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Change the Development Status for an existing Placeholder Asset Type resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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/PlaceholderAssetTypes/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetType->Version | integer | int32 |\r\n| isActive | PlaceholderAssetType->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": "ChangePlaceholderAssetTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/PlaceholderAssetTypes/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetType->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetType->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": "ChangePlaceholderAssetTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/{id}/ClearPlaceholder": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Clear the Placeholder Asset Type.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetPlaceholderAssetTypeEntity->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": "ClearPlaceholderAssetType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ClearPlaceholderAssetTypeResourceActionRequest" } }, { "$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/PlaceholderAssetTypes/{id}/LinkAssetType": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Link the Asset Type.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | LinkAssetTypeEntity->Version | integer | int32 |\r\n| linkedToAssetTypeId | LinkAssetTypeEntity->LinkedToAssetType_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| linkedToAssetTypeId | Required | True | |\r\n| linkedToAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "LinkAssetType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeLinkAssetTypeResourceActionRequest" } }, { "$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/PlaceholderAssetTypes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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/PlaceholderAssetTypes/{id}/SetPlaceholder": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Set the Placeholder Asset Type.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetPlaceholderAssetTypeEntity->Version | integer | int32 |\r\n| placeholderForAssetTypeId | SetPlaceholderAssetTypeEntity->PlaceholderForAssetType_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| placeholderForAssetTypeId | Required | True | |\r\n| placeholderForAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "SetPlaceholderAssetType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/SetPlaceholderAssetTypeResourceActionRequest" } }, { "$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/PlaceholderAssetTypes/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetType->Id | integer | int64 |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| isActive | PlaceholderAssetType->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 | > 1| |\r\n| id | Min Value | > 1| |\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": "BatchChangePlaceholderAssetTypeIsActive", "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/BatchChangePlaceholderAssetTypeIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/PlaceholderAssetTypes/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetType->Id | integer | int64 |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetType->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| id | Min Value | > 1| |\r\n| id | Min Value | > 1| |\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": "BatchChangePlaceholderAssetTypePermissionTree", "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/BatchChangePlaceholderAssetTypePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Batch/ClearPlaceholder": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Clear the Placeholder Asset Type for a collection of existing Placeholder Asset 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 | SetPlaceholderAssetTypeEntity->Id | integer | int64 |\r\n| version | SetPlaceholderAssetTypeEntity->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": "BatchClearPlaceholderAssetType", "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/BatchClearPlaceholderAssetTypeResourceActionRequest" } }, { "$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/PlaceholderAssetTypes/Batch/LinkAssetType": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Link the Asset Type for a collection of existing Placeholder Asset 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 | LinkAssetTypeEntity->Id | integer | int64 |\r\n| version | LinkAssetTypeEntity->Version | integer | int32 |\r\n| linkedToAssetTypeId | LinkAssetTypeEntity->LinkedToAssetType_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| linkedToAssetTypeId | Required | True | |\r\n| linkedToAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchLinkAssetType", "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/BatchLinkAssetTypeResourceActionRequest" } }, { "$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/PlaceholderAssetTypes/Batch/SetPlaceholder": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Set the Placeholder Asset Type for a collection of existing Placeholder Asset 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 | SetPlaceholderAssetTypeEntity->Id | integer | int64 |\r\n| version | SetPlaceholderAssetTypeEntity->Version | integer | int32 |\r\n| placeholderForAssetTypeId | SetPlaceholderAssetTypeEntity->PlaceholderForAssetType_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| placeholderForAssetTypeId | Required | True | |\r\n| placeholderForAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchSetPlaceholderAssetType", "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/BatchSetPlaceholderAssetTypeResourceActionRequest" } }, { "$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/PlaceholderAssetTypes/MatchBatch": { "patch": { "tags": [ "Placeholder Asset Type" ], "summary": "Update a collection of existing Placeholder Asset Type resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| version | PlaceholderAssetType->Version | integer | int32 |\r\n| taskRollUpPointId | PlaceholderAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| assetImportanceId | PlaceholderAssetType->AssetImportance_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 | Min Value | > 1| |\r\n| id | Min Value | > 1| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdatePlaceholderAssetType", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdatePlaceholderAssetTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/{id}": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Get a collection of Placeholder Asset Type Attribute resources for the Placeholder Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeAttribute | PlaceholderAssetTypeAttribute->InheritedFromRegularAssetTypeAttribute | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetTypeAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetTypeAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetTypeAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetTypeAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetTypeAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetTypeAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n", "operationId": "GetPlaceholderAssetTypeAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Attribute", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Update an existing Placeholder Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeAttributeResourceActionRequest" } }, { "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 - Placeholder Asset Type Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/{placeholderAssetTypeId}/Attributes": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Get a collection of Placeholder Asset Type Attribute resources for the Placeholder Asset 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 | PlaceholderAssetTypeAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeAttribute->IsInherited | boolean | |\r\n| attributeId | PlaceholderAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetTypeAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeAttributeCollectionForPlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "placeholderAssetTypeId", "in": "path", "required": true, "description": "Placeholder Asset 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 Placeholder Asset Type Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeAttributeCollectionForPlaceholderAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Get a collection of Placeholder Asset Type Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeAttribute->IsInherited | boolean | |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Description | string | |\r\n| attributeId | PlaceholderAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetTypeAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Create a new Placeholder Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeAttribute->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeAttribute", "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/CreatePlaceholderAssetTypeAttributeResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Attributes/Lookups/LookupPlaceholderAssetTypeAttributeAllowedValue": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Placeholder Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupPlaceholderAssetTypeAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/Lookups/LookupPlaceholderAssetTypeAttribute": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Lookup the Attribute for the Placeholder Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/Lookups/LookupPlaceholderAssetTypeAttributeChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/Lookups/LookupPlaceholderAssetTypeAttributeInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/Lookups/LookupPlaceholderAssetTypeAttributePlaceholderAssetType": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Lookup the Placeholder Asset Type Attribute for the Placeholder Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeAttributePlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeAttributePlaceholderAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Get a collection of Placeholder Asset Type Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeAttribute | PlaceholderAssetTypeAttribute->InheritedFromRegularAssetTypeAttribute | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetTypeAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetTypeAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetTypeAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetTypeAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetTypeAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetTypeAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n", "operationId": "BatchGetPlaceholderAssetTypeAttribute", "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 Placeholder Asset Type Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Attribute collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/Batch": { "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Create a new collection of Placeholder Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeAttribute->PlaceholderAssetType_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeAttribute->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeAttribute", "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/BatchCreatePlaceholderAssetTypeAttributeResourceActionRequest" } }, { "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 - Placeholder Asset Type Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Update a collection of existing Placeholder Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeAttribute", "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/BatchUpdatePlaceholderAssetTypeAttributeResourceActionRequest" } }, { "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 - Placeholder Asset Type Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Placeholder Asset Type Attribute", "description": "", "operationId": "AcceptPlaceholderAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Attribute 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/PlaceholderAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Attribute resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Attribute 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/PlaceholderAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Attribute resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Attribute 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/PlaceholderAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Attribute resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Attribute 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/PlaceholderAssetTypes/Attributes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Attribute resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Attribute 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/PlaceholderAssetTypes/Attributes/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeAttribute->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": "ChangePlaceholderAssetTypeAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeAttributeIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeAttribute->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": "ChangePlaceholderAssetTypeAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Placeholder Asset Type Attribute", "description": "", "operationId": "RejectPlaceholderAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Attribute 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/PlaceholderAssetTypes/Attributes/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeAttribute->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": "BatchChangePlaceholderAssetTypeAttributeIsActive", "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/BatchChangePlaceholderAssetTypeAttributeIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeAttribute->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": "BatchChangePlaceholderAssetTypeAttributePermissionTree", "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/BatchChangePlaceholderAssetTypeAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/{id}": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Get a Placeholder Asset Type Component 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| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetTypeComponent->AssetType_Description | string | |\r\n| assetTypeRecordType | PlaceholderAssetTypeComponent->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| assetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Code | string | |\r\n| assetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Description | string | |\r\n| assetTypeTreePathId | PlaceholderAssetTypeComponent->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | PlaceholderAssetTypeComponent->AssetType_TreePathItems | array | array |\r\n| developmentStatus | PlaceholderAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeComponent->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeComponent->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponent->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | PlaceholderAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | PlaceholderAssetTypeComponent->ParentComponent_Description | string | |\r\n| parentComponentTreePathId | PlaceholderAssetTypeComponent->ParentComponent_TreePathId | integer | int64 |\r\n| parentComponentTreePathItems | PlaceholderAssetTypeComponent->ParentComponent_TreePathItems | array | array |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponent->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | PlaceholderAssetTypeComponent->RulesLastChangedOn | string | date-time |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| createdByUserId | PlaceholderAssetTypeComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponent->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponent->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponent->PermissionTree_Description | string | |\r\n| treePathId | PlaceholderAssetTypeComponent->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAssetTypeComponent->TreePathItems | array | array |\r\n| alternativeDescription | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetTypeComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetTypeComponent->AssetImportance_Description | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| inheritedFromId | PlaceholderAssetTypeComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromTreePathId | PlaceholderAssetTypeComponent->InheritedFrom_TreePathId | integer | int64 |\r\n| inheritedFromTreePathItems | PlaceholderAssetTypeComponent->InheritedFrom_TreePathItems | array | array |\r\n| isHistorical | PlaceholderAssetTypeComponent->IsHistorical | boolean | |\r\n| linkedToAssetTypeId | PlaceholderAssetTypeComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetTypeComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetTypeComponent->LinkedToAssetType_Description | string | |\r\n| linkedToAssetTypeTreePathId | PlaceholderAssetTypeComponent->LinkedToAssetType_TreePathId | integer | int64 |\r\n| linkedToAssetTypeTreePathItems | PlaceholderAssetTypeComponent->LinkedToAssetType_TreePathItems | array | array |\r\n| materialMasterId | PlaceholderAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetTypeComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetTypeComponent->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetTypeComponent->Notes | string | |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Description | string | |\r\n| placeholderForAssetTypeTreePathId | PlaceholderAssetTypeComponent->PlaceholderForAssetType_TreePathId | integer | int64 |\r\n| placeholderForAssetTypeTreePathItems | PlaceholderAssetTypeComponent->PlaceholderForAssetType_TreePathItems | array | array |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| recordType | PlaceholderAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| specification | PlaceholderAssetTypeComponent->Specification | string | |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetTypeComponent->Supplier_Description | string | |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | string | |\r\n", "operationId": "GetPlaceholderAssetTypeComponent", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Component", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Update an existing Placeholder Asset Type Component resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| specification | PlaceholderAssetTypeComponent->Specification | string | |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| materialMasterId | PlaceholderAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | string | |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeComponent->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 | Read-only | True | PlaceholderAssetTypeComponent->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | PlaceholderAssetTypeComponent->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentResourceActionRequest" } }, { "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 - Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Get a collection of Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| isActive | PlaceholderAssetTypeComponent->IsActive | boolean | |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | string | |\r\n| recordType | PlaceholderAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetTypeComponent->AssetType_Description | string | |\r\n| assetTypeTreePathItems | PlaceholderAssetTypeComponent->AssetType_TreePathItems | array | array |\r\n| placeholderForAssetTypeId | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Description | string | |\r\n| linkedToAssetTypeId | PlaceholderAssetTypeComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetTypeComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetTypeComponent->LinkedToAssetType_Description | string | |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | PlaceholderAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | PlaceholderAssetTypeComponent->ParentComponent_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponent->IsInherited | boolean | |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetTypeComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetTypeComponent->AssetImportance_Description | string | |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetTypeComponent->Supplier_Description | string | |\r\n| rulesLastChangedOn | PlaceholderAssetTypeComponent->RulesLastChangedOn | string | date-time |\r\n| notes | PlaceholderAssetTypeComponent->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeComponent->ModifiedOn | string | date-time |\r\n| treePathItems | PlaceholderAssetTypeComponent->TreePathItems | array | array |\r\n", "operationId": "GetPlaceholderAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Create a new Placeholder Asset Type Component resource.", "description": "### Request Body\r\n#### 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 | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| notes | PlaceholderAssetTypeComponent->Notes | string | |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| permissionTreeId | PlaceholderAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| specification | PlaceholderAssetTypeComponent->Specification | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | 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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| parentComponentId | Min Value | >= 0| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeComponent", "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/CreatePlaceholderAssetTypeComponentResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentAssetType": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| recordType | RegularAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeComponentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentImportance": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the Asset Importance for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Importance collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeComponentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentLinkedAssetType": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentLinkedAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentLinkedAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentMaterialMaster": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the Material Master for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeComponentMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentsMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentParentComponent": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the Regular Asset Type Component for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| recordType | AssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentParentComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentParentComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentRegularAssetType": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Lookups/LookupPlaceholderAssetTypeComponentSupplier": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Lookup the Supplier for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeComponentSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Get a collection of Placeholder Asset Type Component 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| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetTypeComponent->AssetType_Description | string | |\r\n| assetTypeRecordType | PlaceholderAssetTypeComponent->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| assetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Code | string | |\r\n| assetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Description | string | |\r\n| assetTypeTreePathId | PlaceholderAssetTypeComponent->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | PlaceholderAssetTypeComponent->AssetType_TreePathItems | array | array |\r\n| developmentStatus | PlaceholderAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeComponent->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeComponent->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponent->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | PlaceholderAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | PlaceholderAssetTypeComponent->ParentComponent_Description | string | |\r\n| parentComponentTreePathId | PlaceholderAssetTypeComponent->ParentComponent_TreePathId | integer | int64 |\r\n| parentComponentTreePathItems | PlaceholderAssetTypeComponent->ParentComponent_TreePathItems | array | array |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponent->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | PlaceholderAssetTypeComponent->RulesLastChangedOn | string | date-time |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| createdByUserId | PlaceholderAssetTypeComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponent->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponent->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponent->PermissionTree_Description | string | |\r\n| treePathId | PlaceholderAssetTypeComponent->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAssetTypeComponent->TreePathItems | array | array |\r\n| alternativeDescription | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetTypeComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetTypeComponent->AssetImportance_Description | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| inheritedFromId | PlaceholderAssetTypeComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromTreePathId | PlaceholderAssetTypeComponent->InheritedFrom_TreePathId | integer | int64 |\r\n| inheritedFromTreePathItems | PlaceholderAssetTypeComponent->InheritedFrom_TreePathItems | array | array |\r\n| isHistorical | PlaceholderAssetTypeComponent->IsHistorical | boolean | |\r\n| linkedToAssetTypeId | PlaceholderAssetTypeComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetTypeComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetTypeComponent->LinkedToAssetType_Description | string | |\r\n| linkedToAssetTypeTreePathId | PlaceholderAssetTypeComponent->LinkedToAssetType_TreePathId | integer | int64 |\r\n| linkedToAssetTypeTreePathItems | PlaceholderAssetTypeComponent->LinkedToAssetType_TreePathItems | array | array |\r\n| materialMasterId | PlaceholderAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetTypeComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetTypeComponent->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetTypeComponent->Notes | string | |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetTypeComponent->PlaceholderForAssetType_Description | string | |\r\n| placeholderForAssetTypeTreePathId | PlaceholderAssetTypeComponent->PlaceholderForAssetType_TreePathId | integer | int64 |\r\n| placeholderForAssetTypeTreePathItems | PlaceholderAssetTypeComponent->PlaceholderForAssetType_TreePathItems | array | array |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| recordType | PlaceholderAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| specification | PlaceholderAssetTypeComponent->Specification | string | |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetTypeComponent->Supplier_Description | string | |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | string | |\r\n", "operationId": "BatchGetPlaceholderAssetTypeComponent", "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 Placeholder Asset Type Component 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 Placeholder Asset Type Component collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeComponentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Batch": { "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Create a new collection of Placeholder Asset Type Component resources.", "description": "### Request Body\r\n#### 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 | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| notes | PlaceholderAssetTypeComponent->Notes | string | |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| permissionTreeId | PlaceholderAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| specification | PlaceholderAssetTypeComponent->Specification | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | 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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| parentComponentId | Min Value | >= 0| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeComponent", "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/BatchCreatePlaceholderAssetTypeComponentResourceActionRequest" } }, { "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 - Placeholder Asset Type Component 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": [ "Placeholder Asset Type Component" ], "summary": "Update a collection of existing Placeholder Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetTypeComponent->AlternativeDescription | string | |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | integer | int32 |\r\n| specification | PlaceholderAssetTypeComponent->Specification | string | |\r\n| partNumber | PlaceholderAssetTypeComponent->PartNumber | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| materialMasterId | PlaceholderAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| supplierId | PlaceholderAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetTypeComponent->SupplierPartNumber | string | |\r\n| assetImportanceId | PlaceholderAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeComponent->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| id | Min Value | > 1| |\r\n| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Read-only | True | PlaceholderAssetTypeComponent->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | PlaceholderAssetTypeComponent->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeComponent", "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/BatchUpdatePlaceholderAssetTypeComponentResourceActionRequest" } }, { "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 - Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Component resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Component resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Component resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Component resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Component resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Component resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponent->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": "ChangePlaceholderAssetTypeComponentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/PlaceholderAssetTypeComponents/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type Component resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponent->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": "ChangePlaceholderAssetTypeComponentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/{id}/ClearComponentPlaceholder": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Clear the Placeholder Asset Type Component.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetPlaceholderAssetTypeComponentEntity->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": "ClearPlaceholderAssetTypeComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ClearPlaceholderAssetTypeComponentResourceActionRequest" } }, { "$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/PlaceholderAssetTypeComponents/{id}/LinkPlaceholderAssetTypeComponent": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Link the Placeholder Asset Type Component.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | LinkPlaceholderAssetTypeComponentEntity->Version | integer | int32 |\r\n| linkedToAssetTypeId | LinkPlaceholderAssetTypeComponentEntity->LinkedToAssetType_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| linkedToAssetTypeId | Required | True | |\r\n| linkedToAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "LinkPlaceholderAssetTypeComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentLinkAssetTypeResourceActionRequest" } }, { "$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/PlaceholderAssetTypeComponents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Component resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/{id}/SetPlaceholderAssetTypeComponent": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Set the Placeholder Asset Type Component.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetPlaceholderAssetTypeComponentEntity->Version | integer | int32 |\r\n| componentPlaceholderForAssetTypeId | SetPlaceholderAssetTypeComponentEntity->ComponentPlaceholderForAssetType_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| componentPlaceholderForAssetTypeId | Required | True | |\r\n| componentPlaceholderForAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "SetPlaceholderAssetTypeComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/SetPlaceholderAssetTypeComponentResourceActionRequest" } }, { "$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/PlaceholderAssetTypeComponents/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponent->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 | > 1| |\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": "BatchChangePlaceholderAssetTypeComponentIsActive", "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/BatchChangePlaceholderAssetTypeComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/PlaceholderAssetTypeComponents/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponent->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| id | Min Value | > 1| |\r\n| id | Min Value | >= 0| |\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": "BatchChangePlaceholderAssetTypeComponentPermissionTree", "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/BatchChangePlaceholderAssetTypeComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/Batch/ClearPlaceholderAssetTypeComponent": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Clear the placeholder for a collection of existing Placeholder Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SetPlaceholderAssetTypeComponentEntity->Id | integer | int64 |\r\n| version | SetPlaceholderAssetTypeComponentEntity->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": "BatchClearPlaceholderAssetTypeComponent", "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/BatchClearPlaceholderAssetTypeComponentResourceActionRequest" } }, { "$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/PlaceholderAssetTypeComponents/Batch/LinkPlaceholderAssetTypeComponent": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Link the Asset Type for a collection of existing Placeholder Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | LinkPlaceholderAssetTypeComponentEntity->Id | integer | int64 |\r\n| version | LinkPlaceholderAssetTypeComponentEntity->Version | integer | int32 |\r\n| linkedToAssetTypeId | LinkPlaceholderAssetTypeComponentEntity->LinkedToAssetType_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| linkedToAssetTypeId | Required | True | |\r\n| linkedToAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchLinkPlaceholderAssetTypeComponent", "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/BatchLinkPlaceholderAssetTypeComponentResourceActionRequest" } }, { "$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/PlaceholderAssetTypeComponents/Batch/SetPlaceholderAssetTypeComponent": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Set the placeholder for a collection of existing Placeholder Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | SetPlaceholderAssetTypeComponentEntity->Id | integer | int64 |\r\n| version | SetPlaceholderAssetTypeComponentEntity->Version | integer | int32 |\r\n| componentPlaceholderForAssetTypeId | SetPlaceholderAssetTypeComponentEntity->ComponentPlaceholderForAssetType_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| componentPlaceholderForAssetTypeId | Required | True | |\r\n| componentPlaceholderForAssetTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchSetPlaceholderAssetTypeComponent", "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/BatchSetPlaceholderAssetTypeComponentResourceActionRequest" } }, { "$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/PlaceholderAssetTypeComponents/MatchBatch": { "patch": { "tags": [ "Placeholder Asset Type Component" ], "summary": "Update a collection of existing Placeholder Asset Type Component resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponent->Version | integer | int32 |\r\n| quantity | PlaceholderAssetTypeComponent->Quantity | 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 | Min Value | > 1| |\r\n| id | Min Value | >= 0| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdatePlaceholderAssetTypeComponent", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdatePlaceholderAssetTypeComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Type Component 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/PlaceholderAssetTypeComponents/Attributes/{id}": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Get a collection of Placeholder Asset Type Component Attribute resources for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeAttribute | PlaceholderAssetTypeComponentAttribute->InheritedFromRegularAssetTypeAttribute | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeComponentAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetTypeComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponentAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetTypeComponentAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetTypeComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetTypeComponentAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n", "operationId": "GetPlaceholderAssetTypeComponentAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Component Attribute", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Update an existing Placeholder Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeComponentAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentAttributeResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/{placeholderAssetTypeComponentId}/Attributes": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Get a collection of Placeholder Asset Type Component Attribute resources for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| attributeId | PlaceholderAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetTypeComponentAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeComponentAttributeCollectionForPlaceholderAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "placeholderAssetTypeComponentId", "in": "path", "required": true, "description": "Placeholder Asset Type 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 Placeholder Asset Type Component Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentAttributeCollectionForPlaceholderAssetTypeComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Get a collection of Placeholder Asset Type Component Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Description | string | |\r\n| attributeId | PlaceholderAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetTypeComponentAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeComponentAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Create a new Placeholder Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentAttribute->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeComponentAttribute", "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/CreatePlaceholderAssetTypeComponentAttributeResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Attributes/Lookups/LookupPlaceholderAssetTypeComponentAttributeAllowedValue": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Placeholder Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes/Lookups/LookupPlaceholderAssetTypeComponentAttribute": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Lookup the Attribute for the Placeholder Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes/Lookups/LookupPlaceholderAssetTypeComponentAttributeChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes/Lookups/LookupPlaceholderAssetTypeComponentAttributeInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes/Lookups/LookupPlaceholderAssetTypeComponentAttributePlaceholderAssetTypeComponent": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Lookup the Placeholder Asset Type Component Attribute for the Placeholder Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentAttributePlaceholderAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentAttributePlaceholderAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Get a collection of Placeholder Asset Type Component Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeAttribute | PlaceholderAssetTypeComponentAttribute->InheritedFromRegularAssetTypeAttribute | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeComponentAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetTypeComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponentAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetTypeComponentAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetTypeComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetTypeComponentAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n", "operationId": "BatchGetPlaceholderAssetTypeComponentAttribute", "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 Placeholder Asset Type Component Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Component Attribute collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeComponentAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes/Batch": { "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Create a new collection of Placeholder Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentAttribute->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeComponentAttribute", "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/BatchCreatePlaceholderAssetTypeComponentAttributeResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Update a collection of existing Placeholder Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeComponentAttribute", "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/BatchUpdatePlaceholderAssetTypeComponentAttributeResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Placeholder Asset Type Component Attribute", "description": "", "operationId": "AcceptPlaceholderAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Attribute 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/PlaceholderAssetTypeComponents/Attributes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Component Attribute resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Attribute 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/PlaceholderAssetTypeComponents/Attributes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Component Attribute resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Attribute 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/PlaceholderAssetTypeComponents/Attributes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Component Attribute resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Attribute 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/PlaceholderAssetTypeComponents/Attributes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Component Attribute resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Attribute 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/PlaceholderAssetTypeComponents/Attributes/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentAttribute->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": "ChangePlaceholderAssetTypeComponentAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentAttributeIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentAttribute->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": "ChangePlaceholderAssetTypeComponentAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Placeholder Asset Type Component Attribute", "description": "", "operationId": "RejectPlaceholderAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Attribute 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/PlaceholderAssetTypeComponents/Attributes/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentAttribute->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": "BatchChangePlaceholderAssetTypeComponentAttributeIsActive", "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/BatchChangePlaceholderAssetTypeComponentAttributeIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentAttribute->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": "BatchChangePlaceholderAssetTypeComponentAttributePermissionTree", "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/BatchChangePlaceholderAssetTypeComponentAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/Conditions/{id}": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Get a Placeholder Asset Type Component 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| createdByUserId | PlaceholderAssetTypeComponentCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponentCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponentCondition->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeComponentCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeComponentCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeComponentCondition->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeComponentCondition->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponentCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentCondition->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Description | string | |\r\n| placeholderAssetTypeComponentAssetTypeId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeComponentCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetTypeComponentCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeComponentCondition->Condition_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentCondition->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeCondition | PlaceholderAssetTypeComponentCondition->InheritedFromRegularAssetTypeCondition | boolean | |\r\n| notes | PlaceholderAssetTypeComponentCondition->Notes | string | |\r\n| state | PlaceholderAssetTypeComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetPlaceholderAssetTypeComponentCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Component Condition", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Update an existing Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeComponentCondition->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| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeComponentCondition->State eq 'Apply' |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeComponentCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentConditionResourceActionRequest" } }, { "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": "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 - Placeholder Asset Type Component 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" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Get a collection of Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Description | string | |\r\n| conditionId | PlaceholderAssetTypeComponentCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeComponentCondition->Condition_Description | string | |\r\n| conditionState | PlaceholderAssetTypeComponentCondition->Condition_State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| conditionConditionTypeCode | PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Description | string | |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| developmentStatus | PlaceholderAssetTypeComponentCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentCondition->IsInherited | boolean | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentCondition->InheritedFrom | integer | int64 |\r\n", "operationId": "GetPlaceholderAssetTypeComponentConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Create a new Placeholder Asset Type Component 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| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentCondition->PermissionTree_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetTypeComponentCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeComponentCondition->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| placeholderAssetTypeComponentId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeComponentCondition->State eq 'Apply' |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeComponentCondition", "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/CreatePlaceholderAssetTypeComponentConditionResourceActionRequest" } }, { "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": "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/PlaceholderAssetTypeComponents/{id}/Conditions": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Get a collection of Placeholder Asset Type Component Condition resources for thePlaceholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| conditionId | PlaceholderAssetTypeComponentCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeComponentCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Description | string | |\r\n| state | PlaceholderAssetTypeComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| developmentStatus | PlaceholderAssetTypeComponentCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentCondition->IsInherited | boolean | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentCondition->InheritedFrom | integer | int64 |\r\n", "operationId": "GetPlaceholderAssetTypeComponentConditionForPlaceholderAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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 Placeholder Asset Type Component Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentConditionForPlaceholderAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/Lookups/LookupPlaceholderAssetTypeComponentConditionChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type Component 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": "LookupPlaceholderAssetTypeComponentConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/Lookups/LookupPlaceholderAssetTypeComponentConditionCondition": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Lookup the Condition for the Placeholder Asset Type Component 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 | Condition->Id | integer | int64 |\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| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/Lookups/LookupPlaceholderAssetTypeComponentConditionInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type Component 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": "LookupPlaceholderAssetTypeComponentConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/Lookups/LookupPlaceholderAssetTypeComponentConditionPlaceholderAssetTypeComponent": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Lookup the Placeholder Asset Type Component for the Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| assetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| assetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Code | string | |\r\n| assetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentConditionPlaceholderAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentConditionPlaceholderAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/Lookups/LookupPlaceholderAssetTypeComponentConditionRegularAssetType": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset Type Component 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 | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentConditionRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentConditionRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Get a collection of Placeholder Asset Type Component 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| createdByUserId | PlaceholderAssetTypeComponentCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponentCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponentCondition->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeComponentCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeComponentCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeComponentCondition->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeComponentCondition->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponentCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentCondition->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Description | string | |\r\n| placeholderAssetTypeComponentAssetTypeId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeComponentCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetTypeComponentCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeComponentCondition->Condition_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentCondition->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeCondition | PlaceholderAssetTypeComponentCondition->InheritedFromRegularAssetTypeCondition | boolean | |\r\n| notes | PlaceholderAssetTypeComponentCondition->Notes | string | |\r\n| state | PlaceholderAssetTypeComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetPlaceholderAssetTypeComponentCondition", "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 Placeholder Asset Type Component 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 Placeholder Asset Type Component Condition collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeComponentConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/Batch": { "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Create a new collection of Placeholder Asset Type Component 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| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentCondition->PermissionTree_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetTypeComponentCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeComponentCondition->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| placeholderAssetTypeComponentId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeComponentCondition->State eq 'Apply' |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeComponentCondition", "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/BatchCreatePlaceholderAssetTypeComponentConditionResourceActionRequest" } }, { "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": "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 - Placeholder Asset Type Component 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": [ "Placeholder Asset Type Component Condition" ], "summary": "Update a collection of existing Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeComponentCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeComponentCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeComponentCondition->State eq 'Apply' |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeComponentCondition", "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/BatchUpdatePlaceholderAssetTypeComponentConditionResourceActionRequest" } }, { "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": "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 - Placeholder Asset Type Component 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" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Component Condition resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Condition 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/PlaceholderAssetTypeComponents/Conditions/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Component Condition resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Condition 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/PlaceholderAssetTypeComponents/Conditions/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Component Condition resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Condition 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/PlaceholderAssetTypeComponents/Conditions/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Component Condition resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Condition 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/PlaceholderAssetTypeComponents/Conditions/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Component Condition resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Condition 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/PlaceholderAssetTypeComponents/Conditions/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentCondition->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": "ChangePlaceholderAssetTypeComponentConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentConditionIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentCondition->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": "ChangePlaceholderAssetTypeComponentConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Component Condition resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Condition 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/PlaceholderAssetTypeComponents/Conditions/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentCondition->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| 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": "BatchChangePlaceholderAssetTypeComponentConditionIsActive", "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/BatchChangePlaceholderAssetTypeComponentConditionIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component Condition" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type Component 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 | PlaceholderAssetTypeComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangePlaceholderAssetTypeComponentConditionPermissionTree", "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/BatchChangePlaceholderAssetTypeComponentConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/Documents/{id}": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Get a collection of Placeholder Asset Type Component Document resources for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeDocument | PlaceholderAssetTypeComponentDocument->InheritedFromRegularAssetTypeDocument | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeComponentDocument->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponentDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | PlaceholderAssetTypeComponentDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponentDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetTypeComponentDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeComponentDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetTypeComponentDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Component Document", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Update an existing Placeholder Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeComponentDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentDocumentResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/{placeholderAssetTypeComponentId}/Documents": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Get a collection of Placeholder Asset Type Component Document resources for the Placeholder Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentDocument->IsInherited | boolean | |\r\n| documentRecordId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeComponentDocument->Notes | string | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentDocument->InheritedFrom | integer | int64 |\r\n| createdOn | PlaceholderAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeComponentDocumentCollectionForPlaceholderAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "placeholderAssetTypeComponentId", "in": "path", "required": true, "description": "Placeholder Asset Type 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 Placeholder Asset Type Component Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentDocumentCollectionForPlaceholderAssetTypeComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Documents": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Get a collection of Placeholder Asset Type Component Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentDocument->IsInherited | boolean | |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Description | string | |\r\n| documentRecordId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeComponentDocument->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeComponentDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Create a new Placeholder Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentDocument->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeComponentDocument", "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/CreatePlaceholderAssetTypeComponentDocumentResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Documents/Lookups/LookupPlaceholderAssetTypeComponentDocumentChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Documents/Lookups/LookupPlaceholderAssetTypeComponentDocument": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Lookup the Document Record for the Placeholder Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentDocumentDocumentRecordLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Documents/Lookups/LookupPlaceholderAssetTypeComponentDocumentInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Documents/Lookups/LookupPlaceholderAssetTypeComponentDocumentPlaceholderAssetTypeComponent": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Lookup the Placeholder Asset Type Component Document for the Placeholder Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentDocumentPlaceholderAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentDocumentPlaceholderAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Documents/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Get a collection of Placeholder Asset Type Component Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeComponentDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeDocument | PlaceholderAssetTypeComponentDocument->InheritedFromRegularAssetTypeDocument | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeComponentDocument->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponentDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | PlaceholderAssetTypeComponentDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeComponentDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetTypeComponentDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeComponentDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPlaceholderAssetTypeComponentDocument", "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 Placeholder Asset Type Component Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Component Document collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeComponentDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Documents/Batch": { "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Create a new collection of Placeholder Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentDocument->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeComponentDocument", "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/BatchCreatePlaceholderAssetTypeComponentDocumentResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Update a collection of existing Placeholder Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeComponentDocument", "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/BatchUpdatePlaceholderAssetTypeComponentDocumentResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Component Document resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Document 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/PlaceholderAssetTypeComponents/Documents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Component Document resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Document 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/PlaceholderAssetTypeComponents/Documents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Component Document resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Document 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/PlaceholderAssetTypeComponents/Documents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Component Document resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Document 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/PlaceholderAssetTypeComponents/Documents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Component Document resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Document 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/PlaceholderAssetTypeComponents/Documents/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentDocument->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": "ChangePlaceholderAssetTypeComponentDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentDocumentIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentDocument->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": "ChangePlaceholderAssetTypeComponentDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Component Document resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Document 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/PlaceholderAssetTypeComponents/Documents/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentDocument->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": "BatchChangePlaceholderAssetTypeComponentDocumentIsActive", "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/BatchChangePlaceholderAssetTypeComponentDocumentIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Component Document" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeComponentDocument->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": "BatchChangePlaceholderAssetTypeComponentDocumentPermissionTree", "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/BatchChangePlaceholderAssetTypeComponentDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypeComponents/RuleLinks/{id}": { "get": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Get a Placeholder Asset Type Component Rule Link 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| ruleId | PlaceholderAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleText | PlaceholderAssetTypeComponentRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | PlaceholderAssetTypeComponentRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentRuleLink->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeComponentRuleLink->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeComponentRuleLink->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentRuleLink->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Description | string | |\r\n| placeholderAssetTypeComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Code | string | |\r\n| placeholderAssetTypeComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Description | string | |\r\n| placeholderAssetTypeComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Code | string | |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Description | string | |\r\n| placeholderAssetTypeComponentParentComponentId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentParentComponentCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Code | string | |\r\n| placeholderAssetTypeComponentParentComponentDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Description | string | |\r\n| placeholderAssetTypeComponentParentComponentQuantity | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Quantity | integer | int32 |\r\n| placeholderAssetTypeComponentParentComponentRecordType | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Code | string | |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Description | string | |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentQuantity | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Quantity | integer | int32 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentRecordType | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| inheritedFromRuleId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleText | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleText | string | |\r\n| inheritedFromRuleRuleCategoryId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | PlaceholderAssetTypeComponentRuleLink->Notes | string | |\r\n", "operationId": "GetPlaceholderAssetTypeComponentRuleLink", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Rule Link Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Component Rule Link", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentRuleLinkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Update an existing Placeholder Asset Type Component Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeComponentRuleLink", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks": { "get": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Get a collection of Placeholder Asset Type Component Rule Link 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 | PlaceholderAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Description | string | |\r\n| placeholderAssetTypeComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Code | string | |\r\n| placeholderAssetTypeComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Description | string | |\r\n| placeholderAssetTypeComponentParentComponentId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentParentComponentCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Code | string | |\r\n| placeholderAssetTypeComponentParentComponentDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Description | string | |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Code | string | |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Description | string | |\r\n| ruleId | PlaceholderAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| isActive | PlaceholderAssetTypeComponentRuleLink->IsActive | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetTypeComponentRuleLinkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component Rule Link collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentRuleLinkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Create a new Placeholder Asset Type Component Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| ruleId | PlaceholderAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| placeholderAssetTypeComponentId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeComponentRuleLink", "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/CreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/{id}/RuleLinks": { "get": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Get a collection of Placeholder Asset Type Component Rule Link resources for the Placeholder Asset Type Component", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| ruleId | PlaceholderAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetTypeComponentRuleLinkForRegularAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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 Placeholder Asset Type Component Rule Link collection", "schema": { "$ref": "#/definitions/GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/RuleLinks/Lookups/LookupPlaceholderAssetTypeComponentRuleLinkRegularAssetTypeComponent": { "get": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Lookup the Placeholder Asset Type Component Rule Link for the Placeholder Asset Type Component Rule Link.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetTypeComponent->Code | string | |\r\n| description | PlaceholderAssetTypeComponent->Description | string | |\r\n| assetTypeId | PlaceholderAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetTypeComponent->AssetType_Description | string | |\r\n| parentComponentId | PlaceholderAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | PlaceholderAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | PlaceholderAssetTypeComponent->ParentComponent_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentRuleLinkRegularAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/RuleLinks/Lookups/LookupPlaceholderAssetTypeComponentRuleLinkRule": { "get": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Lookup the Rule for the Placeholder Asset Type Component Rule Link.", "description": "### Response Body\r\n#### Payload\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| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeComponentRuleLinkRule", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeComponentRuleLinkRuleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/RuleLinks/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Get a collection of Placeholder Asset Type Component Rule Link 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| ruleId | PlaceholderAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleText | PlaceholderAssetTypeComponentRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | PlaceholderAssetTypeComponentRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeComponentRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeComponentRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeComponentRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeComponentRuleLink->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeComponentRuleLink->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeComponentRuleLink->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeComponentRuleLink->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Code | string | |\r\n| placeholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Description | string | |\r\n| placeholderAssetTypeComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Code | string | |\r\n| placeholderAssetTypeComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Description | string | |\r\n| placeholderAssetTypeComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Code | string | |\r\n| placeholderAssetTypeComponentLinkedToAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Description | string | |\r\n| placeholderAssetTypeComponentParentComponentId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Id | integer | int64 |\r\n| placeholderAssetTypeComponentParentComponentCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Code | string | |\r\n| placeholderAssetTypeComponentParentComponentDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Description | string | |\r\n| placeholderAssetTypeComponentParentComponentQuantity | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Quantity | integer | int32 |\r\n| placeholderAssetTypeComponentParentComponentRecordType | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Code | string | |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Description | string | |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeComponentRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentQuantity | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Quantity | integer | int32 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentRecordType | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Description | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeRecordType | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Description | string | |\r\n| inheritedFromRuleId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleText | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleText | string | |\r\n| inheritedFromRuleRuleCategoryId | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | PlaceholderAssetTypeComponentRuleLink->Notes | string | |\r\n", "operationId": "BatchGetPlaceholderAssetTypeComponentRuleLink", "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 Placeholder Asset Type Component Rule Link 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 Placeholder Asset Type Component Rule Link collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeComponentRuleLinkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypeComponents/RuleLinks/Batch": { "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Create a new collection of Placeholder Asset Type Component Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeComponentId | PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Id | integer | int64 |\r\n| ruleId | PlaceholderAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->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| placeholderAssetTypeComponentId | Required | True | |\r\n| placeholderAssetTypeComponentId | Nullable | False | |\r\n| placeholderAssetTypeComponentId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeComponentRuleLink", "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/BatchCreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Rule Link 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": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Update a collection of existing Placeholder Asset Type Component Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| notes | PlaceholderAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeComponentRuleLink->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeComponentRuleLink", "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/BatchUpdatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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 - Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Component Rule Link resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Component Rule Link resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Component Rule Link resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Component Rule Link resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Component Rule Link resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Component Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentRuleLink->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": "ChangePlaceholderAssetTypeComponentRuleLinkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentRuleLinkIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypeComponents/RuleLinks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Component Rule Link resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Component Rule Link 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/PlaceholderAssetTypeComponents/RuleLinks/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Component Rule Link" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Component Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeComponentRuleLink->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| 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": "BatchChangePlaceholderAssetTypeComponentRuleLinkIsActive", "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/BatchChangePlaceholderAssetTypeComponentRuleLinkIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Conditions/{id}": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Get a Placeholder Asset Type 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| createdByUserId | PlaceholderAssetTypeCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeCondition->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeCondition->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeCondition->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeCondition->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeCondition->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeCondition->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeCondition->PlaceholderAssetType_Description | string | |\r\n| placeholderAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetTypeCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetTypeCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetTypeCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | PlaceholderAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromConditionId | PlaceholderAssetTypeCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | PlaceholderAssetTypeCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | PlaceholderAssetTypeCondition->InheritedFrom_Condition_Description | string | |\r\n| notes | PlaceholderAssetTypeCondition->Notes | string | |\r\n| recordType | PlaceholderAssetTypeCondition->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| state | PlaceholderAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetPlaceholderAssetTypeCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Condition", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Update an existing Placeholder Asset Type 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 | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeCondition->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| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeConditionResourceActionRequest" } }, { "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 - Placeholder Asset Type 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" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/{id}/Conditions": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Get a collection of Placeholder Asset Type Condition resources for thePlaceholder Asset 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 | PlaceholderAssetTypeCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| conditionId | PlaceholderAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetTypeCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetTypeCondition->Condition_ConditionType_Description | string | |\r\n| state | PlaceholderAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| developmentStatus | PlaceholderAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeCondition->IsInherited | boolean | |\r\n| inheritedFromId | PlaceholderAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetPlaceholderAssetTypeConditionForPlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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 Placeholder Asset Type Condition collection", "schema": { "$ref": "#/definitions/GetConditionForPlaceholderAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Get a collection of Placeholder Asset Type 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 | PlaceholderAssetTypeCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeCondition->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeCondition->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeCondition->PlaceholderAssetType_Description | string | |\r\n| conditionId | PlaceholderAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeCondition->Condition_Description | string | |\r\n| conditionState | PlaceholderAssetTypeCondition->Condition_State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| developmentStatus | PlaceholderAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeCondition->IsInherited | boolean | |\r\n| inheritedFromId | PlaceholderAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetPlaceholderAssetTypeConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Create a new Placeholder Asset Type 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| placeholderAssetTypeId | PlaceholderAssetTypeCondition->PlaceholderAssetType_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetTypeCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeCondition->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| placeholderAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeCondition", "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/CreatePlaceholderAssetTypeConditionResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Conditions/Lookups/LookupPlaceholderAssetTypeConditionChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type 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": "LookupPlaceholderAssetTypeConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions/Lookups/LookupPlaceholderAssetTypeConditionCondition": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Lookup the Condition for the Placeholder Asset Type 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 | Condition->Id | integer | int64 |\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| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions/Lookups/LookupPlaceholderAssetTypeConditionInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type 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": "LookupPlaceholderAssetTypeConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions/Lookups/LookupPlaceholderAssetTypeConditionPlaceholderAssetType": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Lookup the Placeholder Asset Type for the Placeholder Asset Type 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 | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeConditionPlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeConditionPlaceholderAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions/Lookups/LookupPlaceholderAssetTypeConditionRegularAssetType": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset Type 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 | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeConditionRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeConditionRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Get a collection of Placeholder Asset Type 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| createdByUserId | PlaceholderAssetTypeCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeCondition->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeCondition->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeCondition->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeCondition->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeCondition->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeCondition->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeCondition->PlaceholderAssetType_Description | string | |\r\n| placeholderAssetTypeNearestRegularAssetTypeId | PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeNearestRegularAssetTypeCode | PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Code | string | |\r\n| placeholderAssetTypeNearestRegularAssetTypeDescription | PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetTypeCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetTypeCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetTypeCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetTypeCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | PlaceholderAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromConditionId | PlaceholderAssetTypeCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | PlaceholderAssetTypeCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | PlaceholderAssetTypeCondition->InheritedFrom_Condition_Description | string | |\r\n| notes | PlaceholderAssetTypeCondition->Notes | string | |\r\n| recordType | PlaceholderAssetTypeCondition->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| state | PlaceholderAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetPlaceholderAssetTypeCondition", "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 Placeholder Asset Type 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 Placeholder Asset Type Condition collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions/Batch": { "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Create a new collection of Placeholder Asset Type 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| placeholderAssetTypeId | PlaceholderAssetTypeCondition->PlaceholderAssetType_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetTypeCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeCondition->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| placeholderAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeCondition", "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/BatchCreatePlaceholderAssetTypeConditionResourceActionRequest" } }, { "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 - Placeholder Asset Type 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": [ "Placeholder Asset Type Condition" ], "summary": "Update a collection of existing Placeholder Asset Type 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 | PlaceholderAssetTypeCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | PlaceholderAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | PlaceholderAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | PlaceholderAssetTypeCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | PlaceholderAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeCondition", "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/BatchUpdatePlaceholderAssetTypeConditionResourceActionRequest" } }, { "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 - Placeholder Asset Type 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" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Condition resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Condition 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/PlaceholderAssetTypes/Conditions/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Condition resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Condition 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/PlaceholderAssetTypes/Conditions/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Condition resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Condition 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/PlaceholderAssetTypes/Conditions/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Condition resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Condition 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/PlaceholderAssetTypes/Conditions/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Condition resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Condition 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/PlaceholderAssetTypes/Conditions/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type 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 | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeCondition->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": "ChangePlaceholderAssetTypeConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeConditionIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type 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 | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeCondition->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": "ChangePlaceholderAssetTypeConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Condition resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Condition 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/PlaceholderAssetTypes/Conditions/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type 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 | PlaceholderAssetTypeCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeCondition->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| 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": "BatchChangePlaceholderAssetTypeConditionIsActive", "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/BatchChangePlaceholderAssetTypeConditionIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Condition" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type 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 | PlaceholderAssetTypeCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangePlaceholderAssetTypeConditionPermissionTree", "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/BatchChangePlaceholderAssetTypeConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Documents/{id}": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Get a collection of Placeholder Asset Type Document resources for the Placeholder Asset 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| placeholderAssetTypeId | PlaceholderAssetTypeDocument->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeDocument->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeDocument->PlaceholderAssetType_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeDocument | PlaceholderAssetTypeDocument->InheritedFromRegularAssetTypeDocument | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeDocument->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | PlaceholderAssetTypeDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetTypeDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetTypeDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetTypeDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetTypeDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetTypeDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Document", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Update an existing Placeholder Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeDocumentResourceActionRequest" } }, { "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 - Placeholder Asset Type Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/{id}/Documents": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Get a collection of Placeholder Asset Type Document resources for the Placeholder Asset 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 | PlaceholderAssetTypeDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeDocument->IsInherited | boolean | |\r\n| documentRecordId | PlaceholderAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeDocument->Notes | string | |\r\n| inheritedFrom | PlaceholderAssetTypeDocument->InheritedFrom | integer | int64 |\r\n| createdOn | PlaceholderAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeDocumentCollectionForPlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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 Placeholder Asset Type Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeDocumentCollectionForPlaceholderAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Documents": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Get a collection of Placeholder Asset Type Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeDocument->IsInherited | boolean | |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeDocument->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeDocument->PlaceholderAssetType_Description | string | |\r\n| documentRecordId | PlaceholderAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeDocument->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Create a new Placeholder Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeDocument->PlaceholderAssetType_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeDocument->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeDocument", "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/CreatePlaceholderAssetTypeDocumentResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Documents/Lookups/LookupPlaceholderAssetTypeDocumentChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Documents/Lookups/LookupPlaceholderAssetTypeDocument": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Lookup the Document Record for the Placeholder Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Documents/Lookups/LookupPlaceholderAssetTypeDocumentInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetTypeDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Documents/Lookups/LookupPlaceholderAssetTypeDocumentPlaceholderAssetType": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Lookup the Placeholder Asset Type Document for the Placeholder Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeDocumentPlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeDocumentPlaceholderAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Documents/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Get a collection of Placeholder Asset Type Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeDocument->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeDocument->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeDocument->PlaceholderAssetType_Description | string | |\r\n| inheritedFrom | PlaceholderAssetTypeDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeDocument | PlaceholderAssetTypeDocument->InheritedFromRegularAssetTypeDocument | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | PlaceholderAssetTypeDocument->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | PlaceholderAssetTypeDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetTypeDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetTypeDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetTypeDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetTypeDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetTypeDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetTypeDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPlaceholderAssetTypeDocument", "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 Placeholder Asset Type Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Document collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Documents/Batch": { "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Create a new collection of Placeholder Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeDocument->PlaceholderAssetType_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeDocument->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeDocument", "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/BatchCreatePlaceholderAssetTypeDocumentResourceActionRequest" } }, { "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 - Placeholder Asset Type Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Update a collection of existing Placeholder Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetTypeDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeDocument", "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/BatchUpdatePlaceholderAssetTypeDocumentResourceActionRequest" } }, { "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 - Placeholder Asset Type Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Document resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Document 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/PlaceholderAssetTypes/Documents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Document resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Document 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/PlaceholderAssetTypes/Documents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Document resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Document 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/PlaceholderAssetTypes/Documents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Document resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Document 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/PlaceholderAssetTypes/Documents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Document resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Document 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/PlaceholderAssetTypes/Documents/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeDocument->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": "ChangePlaceholderAssetTypeDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeDocumentIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeDocument->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": "ChangePlaceholderAssetTypeDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Document resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Document 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/PlaceholderAssetTypes/Documents/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeDocument->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": "BatchChangePlaceholderAssetTypeDocumentIsActive", "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/BatchChangePlaceholderAssetTypeDocumentIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Document" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeDocument->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": "BatchChangePlaceholderAssetTypeDocumentPermissionTree", "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/BatchChangePlaceholderAssetTypeDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Responsibilities/{id}": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Get a Placeholder Asset Type Responsibility 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 | PlaceholderAssetTypeResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeResponsibility->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeResponsibility->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeResponsibility->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeResponsibility->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeResponsibility->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeResponsibility->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeResponsibility->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | PlaceholderAssetTypeResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| notes | PlaceholderAssetTypeResponsibility->Notes | string | |\r\n| recordType | PlaceholderAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | PlaceholderAssetTypeResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | PlaceholderAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | PlaceholderAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | PlaceholderAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | PlaceholderAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | PlaceholderAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | PlaceholderAssetTypeResponsibility->Trade_Description | string | |\r\n", "operationId": "GetPlaceholderAssetTypeResponsibility", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Responsibility", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeResponsibilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Update an existing Placeholder Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeResponsibility->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| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeResponsibility", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeResponsibilityResourceActionRequest" } }, { "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 - Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Get a collection of Placeholder Asset Type Responsibility 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 | PlaceholderAssetTypeResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Description | string | |\r\n| isActive | PlaceholderAssetTypeResponsibility->IsActive | boolean | |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| recordType | PlaceholderAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | PlaceholderAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | PlaceholderAssetTypeResponsibility->Section_Description | string | |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetTypeResponsibility->Resource_Code | string | |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | PlaceholderAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | PlaceholderAssetTypeResponsibility->Trade_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeResponsibility->IsInherited | boolean | |\r\n| inheritedFromId | PlaceholderAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeResponsibility->Notes | string | |\r\n| createdOn | PlaceholderAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetTypeResponsibilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeResponsibilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Create a new Placeholder Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeResponsibility->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeResponsibility", "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/CreatePlaceholderAssetTypeResponsibilityResourceActionRequest" } }, { "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/PlaceholderAssetTypes/{placeholderAssetTypeId}/Responsibilities": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Get a collection of Placeholder Asset Type Responsibility resources for the Placeholder Asset 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 | PlaceholderAssetTypeResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | PlaceholderAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | PlaceholderAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | PlaceholderAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | PlaceholderAssetTypeResponsibility->Trade_Description | string | |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailFirstName | PlaceholderAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | PlaceholderAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| notes | PlaceholderAssetTypeResponsibility->Notes | string | |\r\n| isInherited | PlaceholderAssetTypeResponsibility->IsInherited | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetPlaceholderAssetTypeResponsibilityForPlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "placeholderAssetTypeId", "in": "path", "required": true, "description": "Placeholder Asset 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 Placeholder Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeResponsibilityForPlaceholderAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Lookups/LookupPlaceholderAssetTypeResponsibilityChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeResponsibilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Lookups/LookupPlaceholderAssetTypeResponsibilityInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeResponsibilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Lookups/LookupPlaceholderAssetTypeResponsibilityPlaceholderAssetType": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Lookup the Placeholder Asset Type for the Placeholder Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeResponsibilityPlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeResponsibilityPlaceholderAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Lookups/LookupPlaceholderAssetTypeResponsibilityResource": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Lookup the Resource for the Placeholder Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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| sectionCode | Resource->Section_Code | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeResponsibilityResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeResponsibilityResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Lookups/LookupPlaceholderAssetTypeResponsibilityResourceWithTradeFilter": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Lookup the Resource for the Placeholder Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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| sectionId | Resource->Section_Id | integer | int64 |\r\n| sectionCode | Resource->Section_Code | string | |\r\n| idResourceTradeResourceTradeCode | Resource->*Id.ResourceTrade.Resource_Trade_Code | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeResponsibilityResourceWithTradeFilter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Lookups/LookupPlaceholderAssetTypeResponsibilitySection": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Lookup the Section for the Placeholder Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeResponsibilitySection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeResponsibilitySectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Lookups/LookupPlaceholderAssetTypeResponsibilityTrade": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Lookup the Trade for the Placeholder Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTypeResponsibilityTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeResponsibilityTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Get a collection of Placeholder Asset Type Responsibility 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 | PlaceholderAssetTypeResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeResponsibility->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeResponsibility->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeResponsibility->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeResponsibility->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeResponsibility->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeResponsibility->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeResponsibility->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | PlaceholderAssetTypeResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| notes | PlaceholderAssetTypeResponsibility->Notes | string | |\r\n| recordType | PlaceholderAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | PlaceholderAssetTypeResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | PlaceholderAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | PlaceholderAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | PlaceholderAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | PlaceholderAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | PlaceholderAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | PlaceholderAssetTypeResponsibility->Trade_Description | string | |\r\n", "operationId": "BatchGetPlaceholderAssetTypeResponsibility", "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 Placeholder Asset Type Responsibility 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 Placeholder Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeResponsibilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Responsibilities/Batch": { "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Create a new collection of Placeholder Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeResponsibility->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeResponsibility", "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/BatchCreatePlaceholderAssetTypeResponsibilityResourceActionRequest" } }, { "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 - Placeholder Asset Type Responsibility 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": [ "Placeholder Asset Type Responsibility" ], "summary": "Update a collection of existing Placeholder Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeResponsibility->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeResponsibility", "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/BatchUpdatePlaceholderAssetTypeResponsibilityResourceActionRequest" } }, { "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 - Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Responsibility resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Responsibility resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeResponsibility->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": "ChangePlaceholderAssetTypeResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeResponsibilityIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Responsibilities/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeResponsibility->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": "ChangePlaceholderAssetTypeResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Responsibilities/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Responsibility resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Responsibility 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/PlaceholderAssetTypes/Responsibilities/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeResponsibility->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| 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": "BatchChangePlaceholderAssetTypeResponsibilityIsActive", "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/BatchChangePlaceholderAssetTypeResponsibilityIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Responsibilities/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Responsibility" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeResponsibility->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangePlaceholderAssetTypeResponsibilityPermissionTree", "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/BatchChangePlaceholderAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/RuleLinks/{id}": { "get": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Get a Placeholder Asset Type Rule Link 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| ruleId | PlaceholderAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleText | PlaceholderAssetTypeRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | PlaceholderAssetTypeRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeRuleLink->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeRuleLink->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeRuleLink->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeRuleLink->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeRuleLink->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Description | string | |\r\n| placeholderAssetTypeLinkedToAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeLinkedToAssetTypeCode | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Code | string | |\r\n| placeholderAssetTypeLinkedToAssetTypeDescription | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeId | PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeCode | PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeDescription | PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Description | string | |\r\n| inheritedFromRuleId | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleText | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleText | string | |\r\n| inheritedFromRuleRuleCategoryId | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | PlaceholderAssetTypeRuleLink->Notes | string | |\r\n", "operationId": "GetPlaceholderAssetTypeRuleLink", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Rule Link Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Rule Link", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeRuleLinkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Update an existing Placeholder Asset Type Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| notes | PlaceholderAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeRuleLink", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeRuleLinkResourceActionRequest" } }, { "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 - Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks": { "get": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Get a collection of Placeholder Asset Type Rule Link 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 | PlaceholderAssetTypeRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeLinkedToAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeLinkedToAssetTypeCode | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Code | string | |\r\n| placeholderAssetTypeLinkedToAssetTypeDescription | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Description | string | |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Description | string | |\r\n| ruleId | PlaceholderAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| isActive | PlaceholderAssetTypeRuleLink->IsActive | boolean | |\r\n| isInherited | PlaceholderAssetTypeRuleLink->IsInherited | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetTypeRuleLinkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Rule Link collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeRuleLinkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Create a new Placeholder Asset Type Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id | integer | int64 |\r\n| ruleId | PlaceholderAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| placeholderAssetTypeId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeRuleLink", "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/CreatePlaceholderAssetTypeRuleLinkResourceActionRequest" } }, { "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/PlaceholderAssetTypes/{id}/RuleLinks": { "get": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Get a collection of Placeholder Asset Type Rule Link resources for the Placeholder Asset 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 | PlaceholderAssetTypeRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| ruleId | PlaceholderAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetTypeRuleLinkForPlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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 Placeholder Asset Type Rule Link collection", "schema": { "$ref": "#/definitions/GetRuleLinkForPlaceholderAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/RuleLinks/Lookups/LookupPlaceholderAssetTypeRuleLinkPlaceholderAssetType": { "get": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Lookup the Placeholder Asset Type Rule Link for the Placeholder Asset Type Rule Link.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n| linkedToAssetTypeId | PlaceholderAssetType->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetType->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetType->LinkedToAssetType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeRuleLinkPlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeRuleLinkTaskPlaceholderAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/RuleLinks/Lookups/LookupPlaceholderAssetTypeRuleLinkRule": { "get": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Lookup the Rule for the Placeholder Asset Type Rule Link.", "description": "### Response Body\r\n#### Payload\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| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeRuleLinkRule", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeRuleLinkRuleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/RuleLinks/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Get a collection of Placeholder Asset Type Rule Link 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| ruleId | PlaceholderAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | PlaceholderAssetTypeRuleLink->Rule_Code | string | |\r\n| ruleDescription | PlaceholderAssetTypeRuleLink->Rule_Description | string | |\r\n| ruleRuleText | PlaceholderAssetTypeRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | PlaceholderAssetTypeRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeRuleLink->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| developmentStatus | PlaceholderAssetTypeRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeRuleLink->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeRuleLink->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeRuleLink->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeRuleLink->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Description | string | |\r\n| placeholderAssetTypeLinkedToAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeLinkedToAssetTypeCode | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Code | string | |\r\n| placeholderAssetTypeLinkedToAssetTypeDescription | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeId | PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Id | integer | int64 |\r\n| inheritedFromPlaceholderAssetTypeCode | PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Code | string | |\r\n| inheritedFromPlaceholderAssetTypeDescription | PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Description | string | |\r\n| inheritedFromRuleId | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleText | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleText | string | |\r\n| inheritedFromRuleRuleCategoryId | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | PlaceholderAssetTypeRuleLink->Notes | string | |\r\n", "operationId": "BatchGetPlaceholderAssetTypeRuleLink", "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 Placeholder Asset Type Rule Link 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 Placeholder Asset Type Rule Link collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeRuleLinkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/RuleLinks/Batch": { "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Create a new collection of Placeholder Asset Type Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id | integer | int64 |\r\n| ruleId | PlaceholderAssetTypeRuleLink->Rule_Id | integer | int64 |\r\n| notes | PlaceholderAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| placeholderAssetTypeId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeRuleLink", "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/BatchCreatePlaceholderAssetTypeRuleLinkResourceActionRequest" } }, { "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 - Placeholder Asset Type Rule Link 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": [ "Placeholder Asset Type Rule Link" ], "summary": "Update a collection of existing Placeholder Asset Type Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| notes | PlaceholderAssetTypeRuleLink->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetTypeRuleLink->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeRuleLink", "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/BatchUpdatePlaceholderAssetTypeRuleLinkResourceActionRequest" } }, { "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 - Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Rule Link resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Rule Link resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Rule Link resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Rule Link resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Rule Link resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeRuleLink->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": "ChangePlaceholderAssetTypeRuleLinkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeRuleLinkIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/RuleLinks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Rule Link resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Rule Link 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/PlaceholderAssetTypes/RuleLinks/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Rule Link" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetTypeRuleLink->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeRuleLink->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeRuleLink->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| 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": "BatchChangePlaceholderAssetTypeRuleLinkIsActive", "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/BatchChangePlaceholderAssetTypeRuleLinkIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Spares/{id}": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Get a Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeSpare->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeSpare->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeSpare->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeSpare->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeSpare->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeSpare->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeSpare->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeSpare->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeSpare->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeSpare->PlaceholderAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMaterialMasterId | PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| materialMasterId | PlaceholderAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetTypeSpare->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetTypeSpare->Notes | string | |\r\n| recordType | PlaceholderAssetTypeSpare->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetPlaceholderAssetTypeSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Type Spare", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Update an existing Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetTypeSpare->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| isCritical | Nullable | False | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetTypeSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeSpareResourceActionRequest" } }, { "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 - Placeholder Asset Type 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/PlaceholderAssetTypes/Spares": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Get a collection of Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeSpare->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeSpare->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeSpare->PlaceholderAssetType_Description | string | |\r\n| materialMasterId | PlaceholderAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetTypeSpare->MaterialMaster_Description | string | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeSpare->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetTypeSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type Spare collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetTypeSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Create a new Placeholder Asset Type 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| placeholderAssetTypeId | PlaceholderAssetTypeSpare->PlaceholderAssetType_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetTypeSpare->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| placeholderAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| isCritical | Required | True | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Required | True | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetTypeSpare", "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/CreatePlaceholderAssetTypeSpareResourceActionRequest" } }, { "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/PlaceholderAssetTypes/{id}/Spares": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Get a collection of Spare resources for the Placeholder Asset 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 | PlaceholderAssetTypeSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| materialMasterId | PlaceholderAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetTypeSpare->MaterialMaster_Description | string | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| developmentStatus | PlaceholderAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | PlaceholderAssetTypeSpare->IsInherited | boolean | |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n", "operationId": "GetPlaceholderAssetTypeSpareForPlaceholderAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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 Placeholder Asset Type Spare collection", "schema": { "$ref": "#/definitions/GetSpareForPlaceholderAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Spares/Lookups/LookupPlaceholderAssetTypeSpareChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Lookup the permission set for changing the Placeholder Asset Type 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": "LookupPlaceholderAssetTypeSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Spares/Lookups/LookupPlaceholderAssetTypeSpareInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Lookup the permission set for creating the Placeholder Asset Type 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": "LookupPlaceholderAssetTypeSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Spares/Lookups/LookupPlaceholderAssetTypeSpareMaterialMaster": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Lookup the Material Master for the Placeholder Asset Type 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": "LookupPlaceholderAssetTypeSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTypeSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Spares/Lookups/LookupPlaceholderAssetTypeSparePlaceholderAssetType": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Lookup the Placeholder Asset Type for the Placeholder Asset Type 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 | PlaceholderAssetType->Id | integer | int64 |\r\n| code | PlaceholderAssetType->Code | string | |\r\n| description | PlaceholderAssetType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetTypeSparePlaceholderAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetTypeSparePlaceholderAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Spares/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Get a collection of Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetTypeSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetTypeSpare->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetTypeSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetTypeSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetTypeSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetTypeSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetTypeSpare->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetTypeSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetTypeSpare->PermissionTree_Description | string | |\r\n| developmentStatus | PlaceholderAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | PlaceholderAssetTypeSpare->Id | integer | int64 |\r\n| isActive | PlaceholderAssetTypeSpare->IsActive | boolean | |\r\n| isBackup | PlaceholderAssetTypeSpare->IsBackup | boolean | |\r\n| isInherited | PlaceholderAssetTypeSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | PlaceholderAssetTypeSpare->LastConfirmedOn | string | date-time |\r\n| placeholderAssetTypeId | PlaceholderAssetTypeSpare->PlaceholderAssetType_Id | integer | int64 |\r\n| placeholderAssetTypeCode | PlaceholderAssetTypeSpare->PlaceholderAssetType_Code | string | |\r\n| placeholderAssetTypeDescription | PlaceholderAssetTypeSpare->PlaceholderAssetType_Description | string | |\r\n| previousDevelopmentStatus | PlaceholderAssetTypeSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | PlaceholderAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| inheritedFromId | PlaceholderAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMaterialMasterId | PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| materialMasterId | PlaceholderAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetTypeSpare->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetTypeSpare->Notes | string | |\r\n| recordType | PlaceholderAssetTypeSpare->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "BatchGetPlaceholderAssetTypeSpare", "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 Placeholder Asset Type 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 Placeholder Asset Type Spare collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetTypeSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetTypes/Spares/Batch": { "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Create a new collection of Placeholder Asset Type 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| placeholderAssetTypeId | PlaceholderAssetTypeSpare->PlaceholderAssetType_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetTypeSpare->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| placeholderAssetTypeId | Required | True | |\r\n| placeholderAssetTypeId | Nullable | False | |\r\n| placeholderAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| isCritical | Required | True | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Required | True | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetTypeSpare", "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/BatchCreatePlaceholderAssetTypeSpareResourceActionRequest" } }, { "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 - Placeholder Asset Type 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": [ "Placeholder Asset Type Spare" ], "summary": "Update a collection of existing Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetTypeSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetTypeSpare", "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/BatchUpdatePlaceholderAssetTypeSpareResourceActionRequest" } }, { "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 - Placeholder Asset Type 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/PlaceholderAssetTypes/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Accept the Development Status for an existing Placeholder Asset Type Spare resource.", "description": "", "operationId": "AcceptPlaceholderAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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/PlaceholderAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Type Spare resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type 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/PlaceholderAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Change the Development Status for the collection of existing Placeholder Asset Type Spare resource id's.", "description": "", "operationId": "BatchChangePlaceholderAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type 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/PlaceholderAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Type Spare resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Type 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/PlaceholderAssetTypes/Spares/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Change the Development Status for an existing Placeholder Asset Type Spare resource.", "description": "", "operationId": "ChangePlaceholderAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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/PlaceholderAssetTypes/Spares/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Change the IsActive status for an existing Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeSpare->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": "ChangePlaceholderAssetTypeSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeSpareIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeSpare->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": "ChangePlaceholderAssetTypeSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetTypeSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/PlaceholderAssetTypes/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Reject the Development Status for an existing Placeholder Asset Type Spare resource.", "description": "", "operationId": "RejectPlaceholderAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Type 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/PlaceholderAssetTypes/Spares/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| isActive | PlaceholderAssetTypeSpare->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| 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": "BatchChangePlaceholderAssetTypeSpareIsActive", "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/BatchChangePlaceholderAssetTypeSpareIsActiveResourceActionRequest" } }, { "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/PlaceholderAssetTypes/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Type Spare" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Type 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 | PlaceholderAssetTypeSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetTypeSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangePlaceholderAssetTypeSparePermissionTree", "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/BatchChangePlaceholderAssetTypeSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/{id}": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| isActive | RegularAssetType->IsActive | boolean | |\r\n| isBackup | RegularAssetType->IsBackup | boolean | |\r\n| isInherited | RegularAssetType->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetType->LastConfirmedOn | string | date-time |\r\n| nearestRegularAssetTypeId | RegularAssetType->NearestRegularAssetType_Id | integer | int64 |\r\n| parentAssetTypeId | RegularAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | RegularAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | RegularAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | RegularAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| previousDevelopmentStatus | RegularAssetType->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetType->SequenceNumber | integer | int32 |\r\n| code | RegularAssetType->Code | string | |\r\n| createdByUserId | RegularAssetType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetType->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetType->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetType->ModifiedOn | string | date-time |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetType->PermissionTree_Description | string | |\r\n| treePathId | RegularAssetType->TreePathId | integer | int64 |\r\n| treePathItems | RegularAssetType->TreePathItems | array | array |\r\n| allowConditions | RegularAssetType->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetType->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetType->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetType->AssetImportance_Description | string | |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n| description | RegularAssetType->Description | string | |\r\n| notes | RegularAssetType->Notes | string | |\r\n| recordType | RegularAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| taskRollUpPointId | RegularAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAssetType->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAssetType->TaskRollUpPoint_Description | string | |\r\n", "operationId": "GetRegularAssetType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type", "schema": { "$ref": "#/definitions/GetRegularAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type" ], "summary": "Update an existing Regular Asset 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 | RegularAssetType->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetType->SequenceNumber | integer | int32 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| allowConditions | RegularAssetType->AllowConditions | boolean | |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n| assetImportanceId | RegularAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| notes | RegularAssetType->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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| canSelectOnAsset | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateRegularAssetType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeResourceActionRequest" } }, { "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 - Regular Asset 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": [ "Regular Asset Type" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetType->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": "DeleteRegularAssetType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTypes": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Get a collection of Regular Asset Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| isActive | RegularAssetType->IsActive | boolean | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| permissionTreeId | RegularAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetType->PermissionTree_Description | string | |\r\n| sequenceNumber | RegularAssetType->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| assetImportanceId | RegularAssetType->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetType->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetType->AssetImportance_Description | string | |\r\n| parentAssetTypeId | RegularAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | RegularAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | RegularAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | RegularAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| notes | RegularAssetType->Notes | string | |\r\n| createdOn | RegularAssetType->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetType->ModifiedOn | string | date-time |\r\n| treePathItems | RegularAssetType->TreePathItems | array | array |\r\n", "operationId": "GetRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type" ], "summary": "Create a new Regular Asset 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| allowConditions | RegularAssetType->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetType->AssetImportance_Id | integer | int64 |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| notes | RegularAssetType->Notes | string | |\r\n| permissionTreeId | RegularAssetType->PermissionTree_Id | integer | int64 |\r\n| parentAssetTypeId | RegularAssetType->ParentAssetType_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetType->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| canSelectOnAsset | Required | True | |\r\n| canSelectOnAsset | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| parentAssetTypeId | Required | True | |\r\n| parentAssetTypeId | Nullable | False | |\r\n| parentAssetTypeId | Min Value | >= 1| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "CreateRegularAssetType", "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/CreateRegularAssetTypeResourceActionRequest" } }, { "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/RegularAssetTypes/Lookups/LookupRegularAssetTypeAssetImportance": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Lookup the Asset Importance for the Regular Asset 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 | AssetImportance->Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeAssetImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Importance collection", "schema": { "$ref": "#/definitions/RegularAssetTypeAssetImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Lookups/LookupRegularAssetTypeAssetTypeParent": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Lookup the Regular Asset Type for the Regular Asset 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 | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupRegularAssetTypeAssetTypeParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeAssetTypeParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Lookups/LookupRegularAssetTypeChangePermissionTree": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Lookups/LookupRegularAssetTypeInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Lookups/LookupRegularAssetTypeTaskRollUpPoint": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Lookup the Task Roll Up Point for the Regular Asset 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 | TaskRollUpPoint->Id | integer | int64 |\r\n| code | TaskRollUpPoint->Code | string | |\r\n| description | TaskRollUpPoint->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetType->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| isActive | RegularAssetType->IsActive | boolean | |\r\n| isBackup | RegularAssetType->IsBackup | boolean | |\r\n| isInherited | RegularAssetType->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetType->LastConfirmedOn | string | date-time |\r\n| nearestRegularAssetTypeId | RegularAssetType->NearestRegularAssetType_Id | integer | int64 |\r\n| parentAssetTypeId | RegularAssetType->ParentAssetType_Id | integer | int64 |\r\n| parentAssetTypeCode | RegularAssetType->ParentAssetType_Code | string | |\r\n| parentAssetTypeDescription | RegularAssetType->ParentAssetType_Description | string | |\r\n| parentAssetTypeRecordType | RegularAssetType->ParentAssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| previousDevelopmentStatus | RegularAssetType->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetType->SequenceNumber | integer | int32 |\r\n| code | RegularAssetType->Code | string | |\r\n| createdByUserId | RegularAssetType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetType->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetType->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetType->ModifiedOn | string | date-time |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetType->PermissionTree_Description | string | |\r\n| treePathId | RegularAssetType->TreePathId | integer | int64 |\r\n| treePathItems | RegularAssetType->TreePathItems | array | array |\r\n| allowConditions | RegularAssetType->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetType->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetType->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetType->AssetImportance_Description | string | |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n| description | RegularAssetType->Description | string | |\r\n| notes | RegularAssetType->Notes | string | |\r\n| recordType | RegularAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| taskRollUpPointId | RegularAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAssetType->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAssetType->TaskRollUpPoint_Description | string | |\r\n", "operationId": "BatchGetRegularAssetType", "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 Regular Asset 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 Regular Asset Type collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Batch": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Create a new collection of Regular Asset 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| allowConditions | RegularAssetType->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetType->AssetImportance_Id | integer | int64 |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| notes | RegularAssetType->Notes | string | |\r\n| permissionTreeId | RegularAssetType->PermissionTree_Id | integer | int64 |\r\n| parentAssetTypeId | RegularAssetType->ParentAssetType_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetType->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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| canSelectOnAsset | Required | True | |\r\n| canSelectOnAsset | Nullable | False | |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| parentAssetTypeId | Required | True | |\r\n| parentAssetTypeId | Nullable | False | |\r\n| parentAssetTypeId | Min Value | >= 1| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateRegularAssetType", "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/BatchCreateRegularAssetTypeResourceActionRequest" } }, { "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 - Regular Asset 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": [ "Regular Asset Type" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetType->Id | integer | int64 |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| code | RegularAssetType->Code | string | |\r\n| sequenceNumber | RegularAssetType->SequenceNumber | integer | int32 |\r\n| description | RegularAssetType->Description | string | |\r\n| alternativeDescription | RegularAssetType->AlternativeDescription | string | |\r\n| allowConditions | RegularAssetType->AllowConditions | boolean | |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n| assetImportanceId | RegularAssetType->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| notes | RegularAssetType->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| id | Min Value | > 1| |\r\n| id | Min Value | > 1| |\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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| canSelectOnAsset | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateRegularAssetType", "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/BatchUpdateRegularAssetTypeResourceActionRequest" } }, { "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 - Regular Asset 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": [ "Regular Asset Type" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetType->Id | integer | int64 |\r\n| version | RegularAssetType->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| id | Min Value | > 1| |\r\n| id | Min Value | > 1| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetType", "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/BatchDeleteRegularAssetTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTypes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Accept the Development Status for an existing Regular Asset Type resource.", "description": "", "operationId": "AcceptRegularAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Change the Development Status for an existing Regular Asset Type resource.", "description": "", "operationId": "ChangeRegularAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypes/{id}/Active": { "patch": { "tags": [ "Regular Asset Type" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetType->Version | integer | int32 |\r\n| isActive | RegularAssetType->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": "ChangeRegularAssetTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypes/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetType->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetType->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": "ChangeRegularAssetTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Move": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Move Regular Asset Type.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| sourceId | MoveEntity->SourceId | integer | int64 |\r\n| targetId | MoveEntity->TargetId | integer | int64 |\r\n| targetType | MoveEntity->TargetType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| sourceId | Required | True | |\r\n| sourceId | Nullable | False | |\r\n| targetId | Required | True | |\r\n| targetId | Nullable | False | |\r\n| targetType | Required | True | |\r\n| targetType | Nullable | False | |\r\n\r\n", "operationId": "MoveRegularAssetType", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "moveEntity", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MoveRegularAssetTypeResourceActionRequest" } }, { "$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/RegularAssetTypes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type" ], "summary": "Reject the Development Status for an existing Regular Asset Type resource.", "description": "", "operationId": "RejectRegularAssetTypeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypes/Batch/Active": { "patch": { "tags": [ "Regular Asset Type" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetType->Id | integer | int64 |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| isActive | RegularAssetType->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 | > 1| |\r\n| id | Min Value | > 1| |\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": "BatchChangeRegularAssetTypeIsActive", "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/BatchChangeRegularAssetTypeIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypes/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetType->Id | integer | int64 |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetType->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| id | Min Value | > 1| |\r\n| id | Min Value | > 1| |\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": "BatchChangeRegularAssetTypePermissionTree", "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/BatchChangeRegularAssetTypePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/MatchBatch": { "patch": { "tags": [ "Regular Asset Type" ], "summary": "Update a collection of existing Regular Asset Type resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| version | RegularAssetType->Version | integer | int32 |\r\n| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n| taskRollUpPointId | RegularAssetType->TaskRollUpPoint_Id | integer | int64 |\r\n| assetImportanceId | RegularAssetType->AssetImportance_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 | Min Value | > 1| |\r\n| id | Min Value | > 1| |\r\n| canSelectOnAsset | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdateRegularAssetType", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateRegularAssetTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/{id}": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Get a collection of Regular Asset Type Attribute resources for the Regular Asset 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| regularAssetTypeId | RegularAssetTypeAttribute->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeAttribute->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeAttribute->RegularAssetType_Description | string | |\r\n| inheritedFrom | RegularAssetTypeAttribute->InheritedFrom | integer | int64 |\r\n| developmentStatus | RegularAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTypeAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTypeAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| id | RegularAssetTypeAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTypeAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTypeAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTypeAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n", "operationId": "GetRegularAssetTypeAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Attribute", "schema": { "$ref": "#/definitions/GetRegularAssetTypeAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Update an existing Regular Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/{regularAssetTypeId}/Attributes": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Get a collection of Regular Asset Type Attribute resources for the Regular Asset 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 | RegularAssetTypeAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n| notes | RegularAssetTypeAttribute->Notes | string | |\r\n| createdOn | RegularAssetTypeAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeAttributeCollectionForRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeId", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeAttributeCollectionForRegularAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Get a collection of Regular Asset Type Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeAttribute->IsInherited | boolean | |\r\n| regularAssetTypeCode | RegularAssetTypeAttribute->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeAttribute->RegularAssetType_Description | string | |\r\n| attributeId | RegularAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n| notes | RegularAssetTypeAttribute->Notes | string | |\r\n| createdOn | RegularAssetTypeAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Create a new Regular Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeAttribute->RegularAssetType_Id | integer | int64 |\r\n| attributeId | RegularAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeAttribute->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeAttribute", "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/CreateRegularAssetTypeAttributeResourceActionRequest" } }, { "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/RegularAssetTypes/Attributes/Lookups/LookupRegularAssetTypeAttributeAllowedValue": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Regular Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupRegularAssetTypeAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/RegularAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/Lookups/LookupRegularAssetTypeAttribute": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Lookup the Attribute for the Regular Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupRegularAssetTypeAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/RegularAssetTypeAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/Lookups/LookupRegularAssetTypeAttributeChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Lookup the permission set for changing the Regular Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/Lookups/LookupRegularAssetTypeAttributeInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Lookup the permission set for creating the Regular Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/Lookups/LookupRegularAssetTypeAttributeRegularAssetType": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Lookup the Regular Asset Type Attribute for the Regular Asset Type Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeAttributeRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeAttributeRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Get a collection of Regular Asset Type Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeAttribute->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeAttribute->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeAttribute->RegularAssetType_Description | string | |\r\n| inheritedFrom | RegularAssetTypeAttribute->InheritedFrom | integer | int64 |\r\n| developmentStatus | RegularAssetTypeAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTypeAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTypeAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| id | RegularAssetTypeAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTypeAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTypeAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTypeAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTypeAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRegularAssetTypeAttribute", "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 Regular Asset Type Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Attribute collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/Batch": { "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Create a new collection of Regular Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeAttribute->RegularAssetType_Id | integer | int64 |\r\n| attributeId | RegularAssetTypeAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeAttribute->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeAttribute", "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/BatchCreateRegularAssetTypeAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Update a collection of existing Regular Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| value | RegularAssetTypeAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeAttribute", "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/BatchUpdateRegularAssetTypeAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Accept the Development Status for an existing Regular Asset Type Attribute resource.", "description": "", "operationId": "AcceptRegularAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Attribute 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/RegularAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Attribute resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Attribute 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/RegularAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Attribute resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Attribute 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/RegularAssetTypes/Attributes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Attribute resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Attribute 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/RegularAssetTypes/Attributes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Change the Development Status for an existing Regular Asset Type Attribute resource.", "description": "", "operationId": "ChangeRegularAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Attribute 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/RegularAssetTypes/Attributes/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Change the IsActive status for an existing Regular Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTypeAttribute->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": "ChangeRegularAssetTypeAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeAttributeIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeAttribute->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": "ChangeRegularAssetTypeAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Reject the Development Status for an existing Regular Asset Type Attribute resource.", "description": "", "operationId": "RejectRegularAssetTypeAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Attribute 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/RegularAssetTypes/Attributes/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTypeAttribute->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": "BatchChangeRegularAssetTypeAttributeIsActive", "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/BatchChangeRegularAssetTypeAttributeIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeAttribute->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": "BatchChangeRegularAssetTypeAttributePermissionTree", "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/BatchChangeRegularAssetTypeAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeComponents/{id}": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Get a Regular Asset Type Component 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| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeComponent->AssetType_Description | string | |\r\n| assetTypeRecordType | RegularAssetTypeComponent->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathId | RegularAssetTypeComponent->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | RegularAssetTypeComponent->AssetType_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| isActive | RegularAssetTypeComponent->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeComponent->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeComponent->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | RegularAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | RegularAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | RegularAssetTypeComponent->ParentComponent_Description | string | |\r\n| parentComponentTreePathId | RegularAssetTypeComponent->ParentComponent_TreePathId | integer | int64 |\r\n| parentComponentTreePathItems | RegularAssetTypeComponent->ParentComponent_TreePathItems | array | array |\r\n| previousDevelopmentStatus | RegularAssetTypeComponent->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | RegularAssetTypeComponent->RulesLastChangedOn | string | date-time |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| createdByUserId | RegularAssetTypeComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponent->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponent->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeComponent->PermissionTree_Description | string | |\r\n| treePathId | RegularAssetTypeComponent->TreePathId | integer | int64 |\r\n| treePathItems | RegularAssetTypeComponent->TreePathItems | array | array |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetTypeComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetTypeComponent->AssetImportance_Description | string | |\r\n| barcode | RegularAssetTypeComponent->Barcode | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| inheritedFromId | RegularAssetTypeComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromTreePathId | RegularAssetTypeComponent->InheritedFrom_TreePathId | integer | int64 |\r\n| inheritedFromTreePathItems | RegularAssetTypeComponent->InheritedFrom_TreePathItems | array | array |\r\n| isHistorical | RegularAssetTypeComponent->IsHistorical | boolean | |\r\n| materialMasterId | RegularAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeComponent->MaterialMaster_Description | string | |\r\n| notes | RegularAssetTypeComponent->Notes | string | |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| recordType | RegularAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| serialNumber | RegularAssetTypeComponent->SerialNumber | string | |\r\n| specification | RegularAssetTypeComponent->Specification | string | |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetTypeComponent->Supplier_Description | string | |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n", "operationId": "GetRegularAssetTypeComponent", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Component", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Component" ], "summary": "Update an existing Regular Asset Type Component resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| specification | RegularAssetTypeComponent->Specification | string | |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| materialMasterId | RegularAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n| assetImportanceId | RegularAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| barcode | RegularAssetTypeComponent->Barcode | string | |\r\n| serialNumber | RegularAssetTypeComponent->SerialNumber | string | |\r\n| notes | RegularAssetTypeComponent->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 | Read-only | True | RegularAssetTypeComponent->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | RegularAssetTypeComponent->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 900 chars| |\r\n| serialNumber | Min Length | >= 1 chars| |\r\n| serialNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "UpdateRegularAssetTypeComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentResourceActionRequest" } }, { "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 - Regular Asset Type Component 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/RegularAssetTypeComponents": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Get a collection of Regular Asset Type Component 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 | RegularAssetTypeComponent->Id | integer | int64 |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| isActive | RegularAssetTypeComponent->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n| recordType | RegularAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| assetImportanceId | RegularAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetTypeComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetTypeComponent->AssetImportance_Description | string | |\r\n| materialMasterId | RegularAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeComponent->MaterialMaster_Description | string | |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetTypeComponent->Supplier_Description | string | |\r\n| parentComponentId | RegularAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | RegularAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | RegularAssetTypeComponent->ParentComponent_Description | string | |\r\n| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeComponent->AssetType_Description | string | |\r\n| assetTypeTreePathItems | RegularAssetTypeComponent->AssetType_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponent->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeComponent->InheritedFrom_Id | integer | int64 |\r\n| rulesLastChangedOn | RegularAssetTypeComponent->RulesLastChangedOn | string | date-time |\r\n| notes | RegularAssetTypeComponent->Notes | string | |\r\n| createdOn | RegularAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeComponent->ModifiedOn | string | date-time |\r\n| treePathItems | RegularAssetTypeComponent->TreePathItems | array | array |\r\n", "operationId": "GetRegularAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Component collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Create a new Regular Asset Type Component resource.", "description": "### Request Body\r\n#### 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 | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| notes | RegularAssetTypeComponent->Notes | string | |\r\n| permissionTreeId | RegularAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| parentComponentId | RegularAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| materialMasterId | RegularAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| specification | RegularAssetTypeComponent->Specification | string | |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| barcode | RegularAssetTypeComponent->Barcode | string | |\r\n| serialNumber | RegularAssetTypeComponent->SerialNumber | 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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| assetTypeId | Min Value | > 0| |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| parentComponentId | Min Value | >= 0| |\r\n| parentComponentId | Min Value | >= 0| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 900 chars| |\r\n| serialNumber | Min Length | >= 1 chars| |\r\n| serialNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "CreateRegularAssetTypeComponent", "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/CreateRegularAssetTypeComponentResourceActionRequest" } }, { "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/RegularAssetTypeComponents/Lookups/LookupRegularAssetTypeComponentAssetType": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Lookup the Regular Asset Type for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n| recordType | RegularAssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupRegularAssetTypeComponentAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Lookups/LookupRegularAssetTypeComponentChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Lookup the permission set for changing the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeComponentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Lookups/LookupRegularAssetTypeComponentImportance": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Lookup the Asset Importance for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeComponentImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Importance collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Lookups/LookupRegularAssetTypeComponentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Lookup the permission set for creating the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeComponentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Lookups/LookupRegularAssetTypeComponentMaterialMaster": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Lookup the Material Master for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeComponentMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentsMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Lookups/LookupAssetTypeComponentParentComponent": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Lookup the Regular Asset Type Component for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| recordType | AssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetTypeComponentParentComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/AssetTypeComponentParentComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Lookups/LookupRegularAssetTypeComponentSupplier": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Lookup the Supplier for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeComponentSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Component" ], "summary": "Get a collection of Regular Asset Type Component 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| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeComponent->AssetType_Description | string | |\r\n| assetTypeRecordType | RegularAssetTypeComponent->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathId | RegularAssetTypeComponent->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | RegularAssetTypeComponent->AssetType_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetTypeComponent->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| isActive | RegularAssetTypeComponent->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeComponent->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeComponent->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | RegularAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | RegularAssetTypeComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | RegularAssetTypeComponent->ParentComponent_Description | string | |\r\n| parentComponentTreePathId | RegularAssetTypeComponent->ParentComponent_TreePathId | integer | int64 |\r\n| parentComponentTreePathItems | RegularAssetTypeComponent->ParentComponent_TreePathItems | array | array |\r\n| previousDevelopmentStatus | RegularAssetTypeComponent->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| rulesLastChangedOn | RegularAssetTypeComponent->RulesLastChangedOn | string | date-time |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| createdByUserId | RegularAssetTypeComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponent->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponent->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeComponent->PermissionTree_Description | string | |\r\n| treePathId | RegularAssetTypeComponent->TreePathId | integer | int64 |\r\n| treePathItems | RegularAssetTypeComponent->TreePathItems | array | array |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetTypeComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetTypeComponent->AssetImportance_Description | string | |\r\n| barcode | RegularAssetTypeComponent->Barcode | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| inheritedFromId | RegularAssetTypeComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromTreePathId | RegularAssetTypeComponent->InheritedFrom_TreePathId | integer | int64 |\r\n| inheritedFromTreePathItems | RegularAssetTypeComponent->InheritedFrom_TreePathItems | array | array |\r\n| isHistorical | RegularAssetTypeComponent->IsHistorical | boolean | |\r\n| materialMasterId | RegularAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeComponent->MaterialMaster_Description | string | |\r\n| notes | RegularAssetTypeComponent->Notes | string | |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| recordType | RegularAssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| serialNumber | RegularAssetTypeComponent->SerialNumber | string | |\r\n| specification | RegularAssetTypeComponent->Specification | string | |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetTypeComponent->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetTypeComponent->Supplier_Description | string | |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n", "operationId": "BatchGetRegularAssetTypeComponent", "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 Regular Asset Type Component 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 Regular Asset Type Component collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeComponentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Batch": { "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Create a new collection of Regular Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| permissionTreeId | RegularAssetTypeComponent->PermissionTree_Id | integer | int64 |\r\n| parentComponentId | RegularAssetTypeComponent->ParentComponent_Id | integer | int64 |\r\n| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| materialMasterId | RegularAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| specification | RegularAssetTypeComponent->Specification | string | |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| assetImportanceId | RegularAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| barcode | RegularAssetTypeComponent->Barcode | string | |\r\n| serialNumber | RegularAssetTypeComponent->SerialNumber | string | |\r\n| notes | RegularAssetTypeComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | System Generated | true | If no value specified |\r\n| 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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| parentComponentId | Min Value | >= 0| |\r\n| parentComponentId | Min Value | >= 0| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| assetTypeId | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 900 chars| |\r\n| serialNumber | Min Length | >= 1 chars| |\r\n| serialNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeComponent", "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/BatchCreateRegularAssetTypeComponentResourceActionRequest" } }, { "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 - Regular Asset Type Component 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": [ "Regular Asset Type Component" ], "summary": "Update a collection of existing Regular Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| alternativeDescription | RegularAssetTypeComponent->AlternativeDescription | string | |\r\n| materialMasterId | RegularAssetTypeComponent->MaterialMaster_Id | integer | int64 |\r\n| quantity | RegularAssetTypeComponent->Quantity | integer | int32 |\r\n| partNumber | RegularAssetTypeComponent->PartNumber | string | |\r\n| specification | RegularAssetTypeComponent->Specification | string | |\r\n| sequenceNumber | RegularAssetTypeComponent->SequenceNumber | integer | int32 |\r\n| supplierId | RegularAssetTypeComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetTypeComponent->SupplierPartNumber | string | |\r\n| assetImportanceId | RegularAssetTypeComponent->AssetImportance_Id | integer | int64 |\r\n| barcode | RegularAssetTypeComponent->Barcode | string | |\r\n| serialNumber | RegularAssetTypeComponent->SerialNumber | string | |\r\n| notes | RegularAssetTypeComponent->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| id | Min Value | >= 0| |\r\n| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Read-only | True | RegularAssetTypeComponent->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | RegularAssetTypeComponent->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| partNumber | Min Length | >= 1 chars| |\r\n| partNumber | Max Length | <= 50 chars| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 chars| |\r\n| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 900 chars| |\r\n| serialNumber | Min Length | >= 1 chars| |\r\n| serialNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeComponent", "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/BatchUpdateRegularAssetTypeComponentResourceActionRequest" } }, { "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 - Regular Asset Type Component 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/RegularAssetTypeComponents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Accept the Development Status for an existing Regular Asset Type Component resource.", "description": "", "operationId": "AcceptRegularAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component 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/RegularAssetTypeComponents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Component resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component 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/RegularAssetTypeComponents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Component resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component 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/RegularAssetTypeComponents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Component resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component 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/RegularAssetTypeComponents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Change the Development Status for an existing Regular Asset Type Component resource.", "description": "", "operationId": "ChangeRegularAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component 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/RegularAssetTypeComponents/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Component" ], "summary": "Change the IsActive status for an existing Regular Asset Type Component resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponent->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": "ChangeRegularAssetTypeComponentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeComponents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Component" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Component resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponent->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": "ChangeRegularAssetTypeComponentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeComponents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component" ], "summary": "Reject the Development Status for an existing Regular Asset Type Component resource.", "description": "", "operationId": "RejectRegularAssetTypeComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component 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/RegularAssetTypeComponents/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Component" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponent->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| 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": "BatchChangeRegularAssetTypeComponentIsActive", "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/BatchChangeRegularAssetTypeComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeComponents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Component" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Component resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponent->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| id | Min Value | >= 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeComponentPermissionTree", "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/BatchChangeRegularAssetTypeComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeComponents/MatchBatch": { "patch": { "tags": [ "Regular Asset Type Component" ], "summary": "Update a collection of existing Regular Asset Type Component resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| version | RegularAssetTypeComponent->Version | integer | int32 |\r\n| quantity | RegularAssetTypeComponent->Quantity | 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 | Min Value | >= 0| |\r\n| id | Min Value | >= 0| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdateRegularAssetTypeComponent", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateRegularAssetTypeComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type Component 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/RegularAssetTypeComponents/Attributes/{id}": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Get a collection of Regular Asset Type Component Attribute resources for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inheritedFromId | RegularAssetTypeComponentAttribute->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Id | integer | int64 |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Description | string | |\r\n| regularAssetTypeComponentAssetTypeId | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| regularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Code | string | |\r\n| regularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Description | string | |\r\n| developmentStatus | RegularAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeComponentAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponentAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeComponentAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTypeComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTypeComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeComponentAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| id | RegularAssetTypeComponentAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTypeComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTypeComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTypeComponentAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n", "operationId": "GetRegularAssetTypeComponentAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Component Attribute", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Update an existing Regular Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeComponentAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Component Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/{id}/Attributes": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Get a collection of Regular Asset Type Component Attribute resources for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n| notes | RegularAssetTypeComponentAttribute->Notes | string | |\r\n| createdOn | RegularAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n| lastConfirmedOn | RegularAssetTypeComponentAttribute->LastConfirmedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeComponentAttributeCollectionForRegularAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Component Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentAttributeCollectionForRegularAssetTypeComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Get a collection of Regular Asset Type Component Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Description | string | |\r\n| regularAssetTypeComponentAlternativeDescription | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AlternativeDescription | string | |\r\n| regularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Code | string | |\r\n| regularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n| notes | RegularAssetTypeComponentAttribute->Notes | string | |\r\n| createdOn | RegularAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeComponentAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Component Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Create a new Regular Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Id | integer | int64 |\r\n| attributeId | RegularAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentAttribute->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| regularAssetTypeComponentId | Required | True | |\r\n| regularAssetTypeComponentId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeComponentAttribute", "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/CreateRegularAssetTypeComponentAttributeResourceActionRequest" } }, { "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/RegularAssetTypeComponents/Attributes/Lookups/LookupRegularAssetTypeComponentAttributeAllowedValue": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Regular Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupRegularAssetTypeComponentAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes/Lookups/LookupRegularAssetTypeComponentAttribute": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Lookup the Attribute for the Regular Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupRegularAssetTypeComponentAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes/Lookups/LookupRegularAssetTypeComponentAttributeChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Lookup the permission set for changing the Regular Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeComponentAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes/Lookups/LookupRegularAssetTypeComponentAttributeInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Lookup the permission set for creating the Regular Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeComponentAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes/Lookups/LookupRegularAssetTypeComponentAttributeComponent": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Lookup the Regular Asset Type Component Attribute for the Regular Asset Type Component Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeComponent->AssetType_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeComponentAttributeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Component collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentAttributeRegularAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Get a collection of Regular Asset Type Component Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inheritedFromId | RegularAssetTypeComponentAttribute->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Id | integer | int64 |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Description | string | |\r\n| regularAssetTypeComponentAssetTypeId | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| regularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Code | string | |\r\n| regularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Description | string | |\r\n| developmentStatus | RegularAssetTypeComponentAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeComponentAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponentAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeComponentAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTypeComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTypeComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeComponentAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| id | RegularAssetTypeComponentAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTypeComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTypeComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTypeComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTypeComponentAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRegularAssetTypeComponentAttribute", "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 Regular Asset Type Component Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Component Attribute collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeComponentAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes/Batch": { "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Create a new collection of Regular Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Id | integer | int64 |\r\n| attributeId | RegularAssetTypeComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentAttribute->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| regularAssetTypeComponentId | Required | True | |\r\n| regularAssetTypeComponentId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeComponentAttribute", "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/BatchCreateRegularAssetTypeComponentAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Component Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Update a collection of existing Regular Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| value | RegularAssetTypeComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeComponentAttribute", "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/BatchUpdateRegularAssetTypeComponentAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Component Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Accept the Development Status for an existing Regular Asset Type Component Attribute resource.", "description": "", "operationId": "AcceptRegularAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Attribute 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/RegularAssetTypeComponents/Attributes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Component Attribute resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Attribute 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/RegularAssetTypeComponents/Attributes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Component Attribute resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Attribute 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/RegularAssetTypeComponents/Attributes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Component Attribute resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Attribute 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/RegularAssetTypeComponents/Attributes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Change the Development Status for an existing Regular Asset Type Component Attribute resource.", "description": "", "operationId": "ChangeRegularAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Attribute 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/RegularAssetTypeComponents/Attributes/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Change the IsActive status for an existing Regular Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponentAttribute->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": "ChangeRegularAssetTypeComponentAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentAttributeIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeComponents/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Component Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponentAttribute->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": "ChangeRegularAssetTypeComponentAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeComponents/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Reject the Development Status for an existing Regular Asset Type Component Attribute resource.", "description": "", "operationId": "RejectRegularAssetTypeComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Attribute 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/RegularAssetTypeComponents/Attributes/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponentAttribute->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": "BatchChangeRegularAssetTypeComponentAttributeIsActive", "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/BatchChangeRegularAssetTypeComponentAttributeIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeComponents/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Component Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Component Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponentAttribute->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": "BatchChangeRegularAssetTypeComponentAttributePermissionTree", "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/BatchChangeRegularAssetTypeComponentAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeComponents/Documents/{id}": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Get a collection of Regular Asset Type Component Document resources for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Id | integer | int64 |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Description | string | |\r\n| inheritedFrom | RegularAssetTypeComponentDocument->InheritedFrom | integer | int64 |\r\n| developmentStatus | RegularAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeComponentDocument->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeComponentDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponentDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeComponentDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | RegularAssetTypeComponentDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeComponentDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTypeComponentDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTypeComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTypeComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTypeComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeComponentDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeComponentDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Component Document", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Update an existing Regular Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeComponentDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Component Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/{id}/Documents": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Get a collection of Regular Asset Type Component Document resources for the Regular Asset Type Component.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponentDocument->IsInherited | boolean | |\r\n| documentRecordId | RegularAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeComponentDocument->Notes | string | |\r\n| inheritedFrom | RegularAssetTypeComponentDocument->InheritedFrom | integer | int64 |\r\n| createdOn | RegularAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeComponentDocumentCollectionForRegularAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Component Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentDocumentCollectionForRegularAssetTypeComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Documents": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Get a collection of Regular Asset Type Component Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponentDocument->IsInherited | boolean | |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Description | string | |\r\n| documentRecordId | RegularAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeComponentDocument->Notes | string | |\r\n| createdOn | RegularAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeComponentDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Component Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Create a new Regular Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentDocument->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| regularAssetTypeComponentId | Required | True | |\r\n| regularAssetTypeComponentId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeComponentDocument", "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/CreateRegularAssetTypeComponentDocumentResourceActionRequest" } }, { "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/RegularAssetTypeComponents/Documents/Lookups/LookupRegularAssetTypeComponentDocumentChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Lookup the permission set for changing the Regular Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeComponentDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Documents/Lookups/LookupRegularAssetTypeComponentDocument": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Lookup the Document Record for the Regular Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupRegularAssetTypeComponentDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Documents/Lookups/LookupRegularAssetTypeComponentDocumentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Lookup the permission set for creating the Regular Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeComponentDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Documents/Lookups/LookupRegularAssetTypeComponentDocumentRegularAssetTypeComponent": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Lookup the Regular Asset Type Component Document for the Regular Asset Type Component Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeComponentDocumentRegularAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Component collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentDocumentRegularAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Documents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Get a collection of Regular Asset Type Component Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Id | integer | int64 |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Description | string | |\r\n| inheritedFrom | RegularAssetTypeComponentDocument->InheritedFrom | integer | int64 |\r\n| developmentStatus | RegularAssetTypeComponentDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeComponentDocument->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeComponentDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponentDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeComponentDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | RegularAssetTypeComponentDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponentDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeComponentDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTypeComponentDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTypeComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTypeComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTypeComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTypeComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTypeComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeComponentDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetTypeComponentDocument", "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 Regular Asset Type Component Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Component Document collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeComponentDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Documents/Batch": { "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Create a new collection of Regular Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentDocument->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| regularAssetTypeComponentId | Required | True | |\r\n| regularAssetTypeComponentId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeComponentDocument", "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/BatchCreateRegularAssetTypeComponentDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Component Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Update a collection of existing Regular Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeComponentDocument", "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/BatchUpdateRegularAssetTypeComponentDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Component Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Accept the Development Status for an existing Regular Asset Type Component Document resource.", "description": "", "operationId": "AcceptRegularAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Document 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/RegularAssetTypeComponents/Documents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Component Document resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Document 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/RegularAssetTypeComponents/Documents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Component Document resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Document 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/RegularAssetTypeComponents/Documents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Component Document resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Document 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/RegularAssetTypeComponents/Documents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Change the Development Status for an existing Regular Asset Type Component Document resource.", "description": "", "operationId": "ChangeRegularAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Document 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/RegularAssetTypeComponents/Documents/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Change the IsActive status for an existing Regular Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponentDocument->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": "ChangeRegularAssetTypeComponentDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentDocumentIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeComponents/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Component Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponentDocument->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": "ChangeRegularAssetTypeComponentDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeComponents/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Reject the Development Status for an existing Regular Asset Type Component Document resource.", "description": "", "operationId": "RejectRegularAssetTypeComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Document 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/RegularAssetTypeComponents/Documents/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponentDocument->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": "BatchChangeRegularAssetTypeComponentDocumentIsActive", "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/BatchChangeRegularAssetTypeComponentDocumentIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeComponents/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Component Document" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Component Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeComponentDocument->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": "BatchChangeRegularAssetTypeComponentDocumentPermissionTree", "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/BatchChangeRegularAssetTypeComponentDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeComponents/RuleLinks/{id}": { "get": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Get a Regular Asset Type Component Rule Link 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| ruleId | RegularAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeComponentRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | RegularAssetTypeComponentRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponentRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponentRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponentRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeComponentRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponentRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponentRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponentRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| developmentStatus | RegularAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeComponentRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeComponentRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponentRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeComponentRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id | integer | int64 |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Description | string | |\r\n| regularAssetTypeComponentAssetTypeId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| regularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Code | string | |\r\n| regularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeComponentRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeComponentId | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeComponentCode | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Code | string | |\r\n| inheritedFromRegularAssetTypeComponentDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Description | string | |\r\n| inheritedFromRegularAssetTypeComponentAssetTypeId | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Code | string | |\r\n| inheritedFromRegularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Description | string | |\r\n| inheritedFromRuleId | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeComponentRuleLink->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeComponentRuleLink", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Rule Link Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Component Rule Link", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentRuleLinkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Update an existing Regular Asset Type Component Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeComponentRuleLink", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks": { "get": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Get a collection of Regular Asset Type Component Rule Link 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 | RegularAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id | integer | int64 |\r\n| regularAssetTypeComponentAssetTypeId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| regularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Code | string | |\r\n| regularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Description | string | |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Description | string | |\r\n| ruleId | RegularAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| isActive | RegularAssetTypeComponentRuleLink->IsActive | boolean | |\r\n| isInherited | RegularAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeComponentRuleLinkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Component Rule Link collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeComponentRuleLinkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Create a new Regular Asset Type Component Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->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| regularAssetTypeComponentId | Required | True | |\r\n| regularAssetTypeComponentId | Nullable | False | |\r\n| regularAssetTypeComponentId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeComponentRuleLink", "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/CreateRegularAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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/RegularAssetTypeComponents/{id}/RuleLinks": { "get": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Get a collection of Regular Asset Type Component Rule Link resources for the Regular Asset Type Component", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| ruleId | RegularAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTypeComponentRuleLinkForRegularAssetTypeComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Component Rule Link collection", "schema": { "$ref": "#/definitions/GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponse2" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/RuleLinks/Lookups/LookupRegularAssetTypeComponentRuleLinkRegularAssetTypeComponent": { "get": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Lookup the Regular Asset Type Component Rule Link for the Regular Asset Type Component Rule Link.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponent->Id | integer | int64 |\r\n| code | RegularAssetTypeComponent->Code | string | |\r\n| description | RegularAssetTypeComponent->Description | string | |\r\n| assetTypeId | RegularAssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeComponent->AssetType_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeComponentRuleLinkRegularAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Component collection", "schema": { "$ref": "#/definitions/RegularAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/RuleLinks/Lookups/LookupRegularAssetTypeComponentRuleLinkRule": { "get": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Lookup the Rule for the Regular Asset Type Component Rule Link.", "description": "### Response Body\r\n#### Payload\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| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeComponentRuleLinkRule", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeComponentRuleLinkRuleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/RuleLinks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Get a collection of Regular Asset Type Component Rule Link 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| ruleId | RegularAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeComponentRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeComponentRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeComponentRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | RegularAssetTypeComponentRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeComponentRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeComponentRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeComponentRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeComponentRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeComponentRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeComponentRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeComponentRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| developmentStatus | RegularAssetTypeComponentRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeComponentRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeComponentRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeComponentRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeComponentRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeComponentRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id | integer | int64 |\r\n| regularAssetTypeComponentCode | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Code | string | |\r\n| regularAssetTypeComponentDescription | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Description | string | |\r\n| regularAssetTypeComponentAssetTypeId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| regularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Code | string | |\r\n| regularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeComponentRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeComponentId | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeComponentCode | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Code | string | |\r\n| inheritedFromRegularAssetTypeComponentDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Description | string | |\r\n| inheritedFromRegularAssetTypeComponentAssetTypeId | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeComponentAssetTypeCode | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Code | string | |\r\n| inheritedFromRegularAssetTypeComponentAssetTypeDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Description | string | |\r\n| inheritedFromRuleId | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeComponentRuleLink->Notes | string | |\r\n", "operationId": "BatchGetRegularAssetTypeComponentRuleLink", "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 Regular Asset Type Component Rule Link 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 Regular Asset Type Component Rule Link collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeComponentRuleLinkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeComponents/RuleLinks/Batch": { "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Create a new collection of Regular Asset Type Component Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeComponentId | RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeComponentRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->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| regularAssetTypeComponentId | Required | True | |\r\n| regularAssetTypeComponentId | Nullable | False | |\r\n| regularAssetTypeComponentId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeComponentRuleLink", "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/BatchCreateRegularAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Component Rule Link 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": [ "Regular Asset Type Component Rule Link" ], "summary": "Update a collection of existing Regular Asset Type Component Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeComponentRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeComponentRuleLink->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeComponentRuleLink", "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/BatchUpdateRegularAssetTypeComponentRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Accept the Development Status for an existing Regular Asset Type Component Rule Link resource.", "description": "", "operationId": "AcceptRegularAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Component Rule Link resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Component Rule Link resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Component Rule Link resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Change the Development Status for an existing Regular Asset Type Component Rule Link resource.", "description": "", "operationId": "ChangeRegularAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Change the IsActive status for an existing Regular Asset Type Component Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponentRuleLink->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": "ChangeRegularAssetTypeComponentRuleLinkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeComponents/RuleLinks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Reject the Development Status for an existing Regular Asset Type Component Rule Link resource.", "description": "", "operationId": "RejectRegularAssetTypeComponentRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Component Rule Link 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/RegularAssetTypeComponents/RuleLinks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Component Rule Link" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Component Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeComponentRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeComponentRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeComponentRuleLink->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| 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": "BatchChangeRegularAssetTypeComponentRuleLinkIsActive", "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/BatchChangeRegularAssetTypeComponentRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Conditions/{id}": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Get a Regular Asset Type 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| createdByUserId | RegularAssetTypeCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeCondition->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeCondition->Id | integer | int64 |\r\n| isActive | RegularAssetTypeCondition->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeCondition->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeCondition->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeCondition->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeCondition->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeCondition->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetTypeCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTypeCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromConditionId | RegularAssetTypeCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | RegularAssetTypeCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | RegularAssetTypeCondition->InheritedFrom_Condition_Description | string | |\r\n| notes | RegularAssetTypeCondition->Notes | string | |\r\n| recordType | RegularAssetTypeCondition->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| state | RegularAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetRegularAssetTypeCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Condition", "schema": { "$ref": "#/definitions/GetRegularAssetTypeConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Condition" ], "summary": "Update an existing Regular Asset Type 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 | RegularAssetTypeCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | RegularAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | RegularAssetTypeCondition->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| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | RegularAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "UpdateRegularAssetTypeCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeConditionResourceActionRequest" } }, { "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": "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 - Regular Asset Type 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" } } } }, "/Modules/AMPC/RegularAssetTypes/{id}/Conditions": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Get a collection of Regular Asset Type Condition resources for theRegular Asset 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 | RegularAssetTypeCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeCondition->Version | integer | int32 |\r\n| conditionId | RegularAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetTypeCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeCondition->Condition_ConditionType_Description | string | |\r\n| state | RegularAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| developmentStatus | RegularAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeCondition->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetRegularAssetTypeConditionForRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Condition collection", "schema": { "$ref": "#/definitions/GetConditionForRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Conditions": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeCondition->Version | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeCondition->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeCondition->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeCondition->RegularAssetType_Description | string | |\r\n| conditionId | RegularAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeCondition->Condition_Description | string | |\r\n| conditionState | RegularAssetTypeCondition->Condition_State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| conditionConditionTypeCode | RegularAssetTypeCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeCondition->Condition_ConditionType_Description | string | |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| developmentStatus | RegularAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeCondition->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetRegularAssetTypeConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Create a new Regular Asset Type 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| regularAssetTypeId | RegularAssetTypeCondition->RegularAssetType_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| conditionId | RegularAssetTypeCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | RegularAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | RegularAssetTypeCondition->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| regularAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | RegularAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "CreateRegularAssetTypeCondition", "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/CreateRegularAssetTypeConditionResourceActionRequest" } }, { "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": "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/RegularAssetTypes/Conditions/Lookups/LookupRegularAssetTypeConditionChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Lookup the permission set for changing the Regular Asset Type 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": "LookupRegularAssetTypeConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Conditions/Lookups/LookupRegularAssetTypeConditionCondition": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Lookup the Condition for the Regular Asset Type 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 | Condition->Id | integer | int64 |\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| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Conditions/Lookups/LookupRegularAssetTypeConditionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Lookup the permission set for creating the Regular Asset Type 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": "LookupRegularAssetTypeConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Conditions/Lookups/LookupRegularAssetTypeConditionRegularAssetType": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Lookup the Regular Asset Type for the Regular Asset Type 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 | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeConditionRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeConditionRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Conditions/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Condition" ], "summary": "Get a collection of Regular Asset Type 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| createdByUserId | RegularAssetTypeCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeCondition->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeCondition->Id | integer | int64 |\r\n| isActive | RegularAssetTypeCondition->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeCondition->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeCondition->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeCondition->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeCondition->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeCondition->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTypeCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetTypeCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTypeCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetTypeCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromConditionId | RegularAssetTypeCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | RegularAssetTypeCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | RegularAssetTypeCondition->InheritedFrom_Condition_Description | string | |\r\n| notes | RegularAssetTypeCondition->Notes | string | |\r\n| recordType | RegularAssetTypeCondition->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| state | RegularAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetRegularAssetTypeCondition", "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 Regular Asset Type 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 Regular Asset Type Condition collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Conditions/Batch": { "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Create a new collection of Regular Asset Type 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| regularAssetTypeId | RegularAssetTypeCondition->RegularAssetType_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeCondition->PermissionTree_Id | integer | int64 |\r\n| conditionId | RegularAssetTypeCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | RegularAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | RegularAssetTypeCondition->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| regularAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | RegularAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeCondition", "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/BatchCreateRegularAssetTypeConditionResourceActionRequest" } }, { "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": "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 - Regular Asset Type 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": [ "Regular Asset Type Condition" ], "summary": "Update a collection of existing Regular Asset Type 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 | RegularAssetTypeCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeCondition->SequenceNumber | integer | int32 |\r\n| state | RegularAssetTypeCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeCondition->AdjustmentFactor | number | decimal |\r\n| notes | RegularAssetTypeCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| state | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | RegularAssetTypeCondition->State eq 'Apply' |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeCondition", "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/BatchUpdateRegularAssetTypeConditionResourceActionRequest" } }, { "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": "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 - Regular Asset Type 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" } } } }, "/Modules/AMPC/RegularAssetTypes/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Accept the Development Status for an existing Regular Asset Type Condition resource.", "description": "", "operationId": "AcceptRegularAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Condition 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/RegularAssetTypes/Conditions/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Condition resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Condition 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/RegularAssetTypes/Conditions/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Condition resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Condition 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/RegularAssetTypes/Conditions/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Condition resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Condition 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/RegularAssetTypes/Conditions/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Change the Development Status for an existing Regular Asset Type Condition resource.", "description": "", "operationId": "ChangeRegularAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Condition 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/RegularAssetTypes/Conditions/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Condition" ], "summary": "Change the IsActive status for an existing Regular Asset Type 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 | RegularAssetTypeCondition->Version | integer | int32 |\r\n| isActive | RegularAssetTypeCondition->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": "ChangeRegularAssetTypeConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeConditionIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Condition" ], "summary": "Change the PermissionTree for an existing Regular Asset Type 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 | RegularAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeCondition->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": "ChangeRegularAssetTypeConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Condition" ], "summary": "Reject the Development Status for an existing Regular Asset Type Condition resource.", "description": "", "operationId": "RejectRegularAssetTypeConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Condition 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/RegularAssetTypes/Conditions/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Condition" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type 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 | RegularAssetTypeCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeCondition->Version | integer | int32 |\r\n| isActive | RegularAssetTypeCondition->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| 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": "BatchChangeRegularAssetTypeConditionIsActive", "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/BatchChangeRegularAssetTypeConditionIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Condition" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type 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 | RegularAssetTypeCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangeRegularAssetTypeConditionPermissionTree", "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/BatchChangeRegularAssetTypeConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Documents/{id}": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Get a collection of Regular Asset Type Document resources for the Regular Asset 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| regularAssetTypeId | RegularAssetTypeDocument->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeDocument->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeDocument->RegularAssetType_Description | string | |\r\n| inheritedFrom | RegularAssetTypeDocument->InheritedFrom | integer | int64 |\r\n| developmentStatus | RegularAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeDocument->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | RegularAssetTypeDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTypeDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTypeDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTypeDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTypeDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Document", "schema": { "$ref": "#/definitions/GetRegularAssetTypeDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Document" ], "summary": "Update an existing Regular Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/{id}/Documents": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Get a collection of Regular Asset Type Document resources for the Regular Asset 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 | RegularAssetTypeDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeDocument->IsInherited | boolean | |\r\n| documentRecordId | RegularAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeDocument->Notes | string | |\r\n| inheritedFrom | RegularAssetTypeDocument->InheritedFrom | integer | int64 |\r\n| createdOn | RegularAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeDocumentCollectionForRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeDocumentCollectionForRegularAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Documents": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Get a collection of Regular Asset Type Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeDocument->IsInherited | boolean | |\r\n| regularAssetTypeCode | RegularAssetTypeDocument->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeDocument->RegularAssetType_Description | string | |\r\n| documentRecordId | RegularAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeDocument->Notes | string | |\r\n| createdOn | RegularAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Create a new Regular Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeDocument->RegularAssetType_Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeDocument->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeDocument", "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/CreateRegularAssetTypeDocumentResourceActionRequest" } }, { "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/RegularAssetTypes/Documents/Lookups/LookupRegularAssetTypeDocumentChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Lookup the permission set for changing the Regular Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Documents/Lookups/LookupRegularAssetTypeDocument": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Lookup the Document Record for the Regular Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupRegularAssetTypeDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/RegularAssetTypeDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Documents/Lookups/LookupRegularAssetTypeDocumentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Lookup the permission set for creating the Regular Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Documents/Lookups/LookupRegularAssetTypeDocumentRegularAssetType": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Lookup the Regular Asset Type Document for the Regular Asset Type Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeDocumentRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeDocumentRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Documents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Document" ], "summary": "Get a collection of Regular Asset Type Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeDocument->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeDocument->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeDocument->RegularAssetType_Description | string | |\r\n| inheritedFrom | RegularAssetTypeDocument->InheritedFrom | integer | int64 |\r\n| developmentStatus | RegularAssetTypeDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeDocument->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | RegularAssetTypeDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTypeDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTypeDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTypeDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTypeDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTypeDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTypeDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTypeDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetTypeDocument", "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 Regular Asset Type Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Document collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Documents/Batch": { "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Create a new collection of Regular Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeDocument->RegularAssetType_Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeDocument->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeDocument", "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/BatchCreateRegularAssetTypeDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Document" ], "summary": "Update a collection of existing Regular Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeDocument", "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/BatchUpdateRegularAssetTypeDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Accept the Development Status for an existing Regular Asset Type Document resource.", "description": "", "operationId": "AcceptRegularAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Document 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/RegularAssetTypes/Documents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Document resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Document 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/RegularAssetTypes/Documents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Document resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Document 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/RegularAssetTypes/Documents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Document resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Document 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/RegularAssetTypes/Documents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Change the Development Status for an existing Regular Asset Type Document resource.", "description": "", "operationId": "ChangeRegularAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Document 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/RegularAssetTypes/Documents/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Document" ], "summary": "Change the IsActive status for an existing Regular Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTypeDocument->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": "ChangeRegularAssetTypeDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeDocumentIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Document" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeDocument->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": "ChangeRegularAssetTypeDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Document" ], "summary": "Reject the Development Status for an existing Regular Asset Type Document resource.", "description": "", "operationId": "RejectRegularAssetTypeDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Document 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/RegularAssetTypes/Documents/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Document" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTypeDocument->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": "BatchChangeRegularAssetTypeDocumentIsActive", "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/BatchChangeRegularAssetTypeDocumentIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Document" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeDocument->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": "BatchChangeRegularAssetTypeDocumentPermissionTree", "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/BatchChangeRegularAssetTypeDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/FileAttachments/{id}/Download": { "get": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Download the content for a Regular Asset Type File Attachment resource.", "description": "", "operationId": "GetRegularAssetTypeFileAttachmentContent", "produces": [ "*/*", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "type": "integer", "name": "cv", "in": "query", "description": "Return older version of attachment content", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments/{id}": { "get": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Get a Regular Asset Type File Attachment resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeFileAttachment->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeFileAttachment->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeFileAttachment->RegularAssetType_Description | string | |\r\n| createdByUserId | RegularAssetTypeFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RegularAssetTypeFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RegularAssetTypeFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RegularAssetTypeFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RegularAssetTypeFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RegularAssetTypeFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RegularAssetTypeFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RegularAssetTypeFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RegularAssetTypeFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RegularAssetTypeFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RegularAssetTypeFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTypeFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTypeFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RegularAssetTypeFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RegularAssetTypeFileAttachment->FileFullName | string | |\r\n| fileName | RegularAssetTypeFileAttachment->FileName | string | |\r\n| fileTypeId | RegularAssetTypeFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RegularAssetTypeFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n| id | RegularAssetTypeFileAttachment->Id | integer | int64 |\r\n| isActive | RegularAssetTypeFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeFileAttachment->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeFileAttachment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type File Attachment", "schema": { "$ref": "#/definitions/GetRegularAssetTypeFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Update an existing Regular Asset Type File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | RegularAssetTypeFileAttachment->FileName | string | |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeFileAttachment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type File Attachment was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Delete an existing Regular Asset Type File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeFileAttachment->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": "DeleteRegularAssetTypeFileAttachment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTypeFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type File Attachment was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/{id}/FileAttachments": { "get": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Get a collection of Regular Asset Type File Attachment resources for the Regular Asset 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 | RegularAssetTypeFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTypeFileAttachment->Version | integer | int32 |\r\n| fileFullName | RegularAssetTypeFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RegularAssetTypeFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTypeFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTypeFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RegularAssetTypeFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RegularAssetTypeFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeFileAttachment->ModifiedOn | string | date-time |\r\n| regularAssetTypeCode | RegularAssetTypeFileAttachment->RegularAssetType_Code | string | |\r\n", "operationId": "GetRegularAssetTypeFileAttachmentCollectionForRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeFileAttachmentCollectionForRegularAssetTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments": { "get": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Get a collection of Regular Asset Type File Attachment resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTypeFileAttachment->Version | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeFileAttachment->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeFileAttachment->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeFileAttachment->RegularAssetType_Description | string | |\r\n| fileFullName | RegularAssetTypeFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RegularAssetTypeFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | RegularAssetTypeFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTypeFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTypeFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RegularAssetTypeFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RegularAssetTypeFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeFileAttachmentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments/Upload": { "post": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Upload and create a new Regular Asset Type File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeFileAttachment->RegularAssetType_Id | integer | int64 |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetTypeFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RegularAssetTypeFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRegularAssetTypeFileAttachmentResourceActionRequest" } } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments/{id}/Upload": { "put": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Upload new content for an existing Regular Asset Type File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeFileAttachment->Version | integer | int32 |\r\n| bytes | RegularAssetTypeFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeFileAttachmentContent", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "entityFilePatch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Get a collection of Regular Asset Type File Attachment resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeFileAttachment->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeFileAttachment->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeFileAttachment->RegularAssetType_Description | string | |\r\n| createdByUserId | RegularAssetTypeFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RegularAssetTypeFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RegularAssetTypeFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RegularAssetTypeFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RegularAssetTypeFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RegularAssetTypeFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RegularAssetTypeFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RegularAssetTypeFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RegularAssetTypeFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RegularAssetTypeFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RegularAssetTypeFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTypeFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTypeFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RegularAssetTypeFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RegularAssetTypeFileAttachment->FileFullName | string | |\r\n| fileName | RegularAssetTypeFileAttachment->FileName | string | |\r\n| fileTypeId | RegularAssetTypeFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RegularAssetTypeFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n| id | RegularAssetTypeFileAttachment->Id | integer | int64 |\r\n| isActive | RegularAssetTypeFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeFileAttachment->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetTypeFileAttachment", "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 Regular Asset Type File Attachment id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Regular Asset Type File Attachment.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentContentHistory->Id | integer | int64 |\r\n| version | FileAttachmentContentHistory->Version | integer | int32 |\r\n| contentId | FileAttachmentContentHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | FileAttachmentContentHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | FileAttachmentContentHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | FileAttachmentContentHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | FileAttachmentContentHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | FileAttachmentContentHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | FileAttachmentContentHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | FileAttachmentContentHistory->ContentVersion | integer | int32 |\r\n| createdOn | FileAttachmentContentHistory->CreatedOn | string | date-time |\r\n| fileAttachmentId | FileAttachmentContentHistory->FileAttachment_Id | integer | int64 |\r\n", "operationId": "GetRegularAssetTypeFileAttachmentContentHistory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments/Upload/Batch": { "post": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Upload and create a new collection of Regular Asset Type File Attachment resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeFileAttachment->RegularAssetType_Id | integer | int64 |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetTypeFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RegularAssetTypeFileAttachment->Bytes | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRegularAssetTypeFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset Type File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/FileAttachments/Batch": { "patch": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Update a collection of existing Regular Asset Type File Attachment resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTypeFileAttachment->Version | integer | int32 |\r\n| isRestricted | RegularAssetTypeFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetTypeFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetTypeFileAttachment->FileCategory_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeFileAttachment", "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/BatchUpdateRegularAssetTypeFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type File Attachment batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Type File Attachment" ], "summary": "Delete a collection of existing Regular Asset Type File Attachment resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTypeFileAttachment->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": "BatchDeleteRegularAssetTypeFileAttachment", "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/BatchDeleteRegularAssetTypeFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type File Attachment batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/{id}": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Get a Regular Asset Type Monitoring Point Trigger resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RegularAssetTypeMonitoringPointTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeMonitoringPointTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeMonitoringPointTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeMonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeMonitoringPointTrigger->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeMonitoringPointTrigger->Id | integer | int64 |\r\n| isActive | RegularAssetTypeMonitoringPointTrigger->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeMonitoringPointTrigger->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeMonitoringPointTrigger->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeMonitoringPointTrigger->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeMonitoringPointTrigger->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeMonitoringPointTrigger->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | RegularAssetTypeMonitoringPointTrigger->LastConfirmedChangeLogId | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Description | string | |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeMonitoringPointTrigger", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Monitoring Point Trigger", "schema": { "$ref": "#/definitions/GetRegularAssetTypeMonitoringPointTriggerResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Update an existing Regular Asset Type Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeMonitoringPointTrigger", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeMonitoringPointTriggerResourceActionRequest" } }, { "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 - Regular Asset Type Monitoring Point Trigger was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Get a collection of Regular Asset Type Monitoring Point Trigger resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Description | string | |\r\n| monitoringPointTriggerId | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Description | string | |\r\n| isActive | RegularAssetTypeMonitoringPointTrigger->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeMonitoringPointTrigger->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeMonitoringPointTrigger->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->Notes | string | |\r\n| createdOn | RegularAssetTypeMonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeMonitoringPointTrigger->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeMonitoringPointTriggerCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Monitoring Point Trigger collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeMonitoringPointTriggerCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Create a new Regular Asset Type Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| monitoringPointTriggerId | Required | True | |\r\n| monitoringPointTriggerId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeMonitoringPointTrigger", "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/CreateRegularAssetTypeMonitoringPointTriggerResourceActionRequest" } }, { "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/RegularAssetTypes/{regularAssetTypeId}/MonitoringPointTriggers": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Get a collection of Regular Asset Type Monitoring Point Trigger resources for the Regular Asset 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 | RegularAssetTypeMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Description | string | |\r\n| monitoringPointTriggerId | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Description | string | |\r\n| developmentStatus | RegularAssetTypeMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeMonitoringPointTrigger->IsInherited | boolean | |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeMonitoringPointTriggerForRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeId", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Monitoring Point Trigger collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeMonitoringPointTriggerForRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/Lookups/LookupRegularAssetTypeMonitoringPointTriggerChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Lookup the permission set for changing the Regular Asset Type Monitoring Point Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeMonitoringPointTriggerChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/Lookups/LookupRegularAssetTypeMonitoringPointTriggerInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Lookup the permission set for creating the Regular Asset Type Monitoring Point Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeMonitoringPointTriggerInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/Lookups/LookupRegularAssetTypeMonitoringPointTriggerMonitoringPointTrigger": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Lookup the Monitoring Point Trigger for the Regular Asset Type Monitoring Point Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeMonitoringPointTriggerMonitoringPointTrigger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Monitoring Point Trigger collection", "schema": { "$ref": "#/definitions/RegularAssetTypeMonitoringPointTriggerMonitoringPointTriggerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/Lookups/LookupRegularAssetTypeMonitoringPointTriggerRegularAssetType": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Lookup the Regular Asset Type for the Regular Asset Type Monitoring Point Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeMonitoringPointTriggerRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeMonitoringPointTriggerRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Get a collection of Regular Asset Type Monitoring Point Trigger resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RegularAssetTypeMonitoringPointTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeMonitoringPointTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeMonitoringPointTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeMonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeMonitoringPointTrigger->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeMonitoringPointTrigger->Id | integer | int64 |\r\n| isActive | RegularAssetTypeMonitoringPointTrigger->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeMonitoringPointTrigger->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeMonitoringPointTrigger->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeMonitoringPointTrigger->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeMonitoringPointTrigger->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeMonitoringPointTrigger->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | RegularAssetTypeMonitoringPointTrigger->LastConfirmedChangeLogId | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Description | string | |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->Notes | string | |\r\n", "operationId": "BatchGetRegularAssetTypeMonitoringPointTrigger", "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 Regular Asset Type Monitoring Point Trigger id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Monitoring Point Trigger collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeMonitoringPointTriggerResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/Batch": { "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Create a new collection of Regular Asset Type Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| monitoringPointTriggerId | Required | True | |\r\n| monitoringPointTriggerId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeMonitoringPointTrigger", "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/BatchCreateRegularAssetTypeMonitoringPointTriggerResourceActionRequest" } }, { "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 - Regular Asset Type Monitoring Point Trigger batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Update a collection of existing Regular Asset Type Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeMonitoringPointTrigger->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeMonitoringPointTrigger", "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/BatchUpdateRegularAssetTypeMonitoringPointTriggerResourceActionRequest" } }, { "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 - Regular Asset Type Monitoring Point Trigger batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/MonitoringPointTriggers/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Accept the Development Status for an existing Regular Asset Type Monitoring Point Trigger resource.", "description": "", "operationId": "AcceptRegularAssetTypeMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Monitoring Point Trigger 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/RegularAssetTypes/MonitoringPointTriggers/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Monitoring Point Trigger resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Monitoring Point Trigger 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/RegularAssetTypes/MonitoringPointTriggers/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Monitoring Point Trigger resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Monitoring Point Trigger 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/RegularAssetTypes/MonitoringPointTriggers/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Monitoring Point Trigger resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Monitoring Point Trigger 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/RegularAssetTypes/MonitoringPointTriggers/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Change the Development Status for an existing Regular Asset Type Monitoring Point Trigger resource.", "description": "", "operationId": "ChangeRegularAssetTypeMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Monitoring Point Trigger 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/RegularAssetTypes/MonitoringPointTriggers/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Change the IsActive status for an existing Regular Asset Type Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| isActive | RegularAssetTypeMonitoringPointTrigger->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": "ChangeRegularAssetTypeMonitoringPointTriggerIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeMonitoringPointTriggerIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/MonitoringPointTriggers/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeMonitoringPointTrigger->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": "ChangeRegularAssetTypeMonitoringPointTriggerPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeMonitoringPointTriggerPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/MonitoringPointTriggers/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Reject the Development Status for an existing Regular Asset Type Monitoring Point Trigger resource.", "description": "", "operationId": "RejectRegularAssetTypeMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Monitoring Point Trigger 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/RegularAssetTypes/MonitoringPointTriggers/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| isActive | RegularAssetTypeMonitoringPointTrigger->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| 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": "BatchChangeRegularAssetTypeMonitoringPointTriggerIsActive", "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/BatchChangeRegularAssetTypeMonitoringPointTriggerIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/MonitoringPointTriggers/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Monitoring Point Trigger" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetTypeMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeMonitoringPointTrigger->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangeRegularAssetTypeMonitoringPointTriggerPermissionTree", "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/BatchChangeRegularAssetTypeMonitoringPointTriggerPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Options/{id}": { "get": { "tags": [ "Regular Asset Type Option" ], "summary": "Get a Regular Asset Type 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 | RegularAssetTypeOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeOption->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeOption->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeOption->Version | integer | int32 |\r\n| id | RegularAssetTypeOption->Id | integer | int64 |\r\n| assetTypeId | RegularAssetTypeOption->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeOption->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeOption->AssetType_Description | string | |\r\n| optionId | RegularAssetTypeOption->Option_Id | integer | int64 |\r\n| optionCode | RegularAssetTypeOption->Option_Code | string | |\r\n| optionDescription | RegularAssetTypeOption->Option_Description | string | |\r\n| optionDataType | RegularAssetTypeOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionLowerBounds | RegularAssetTypeOption->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetTypeOption->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | RegularAssetTypeOption->Option_AllowMultipleValues | boolean | |\r\n| optionOptionCategoryId | RegularAssetTypeOption->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | RegularAssetTypeOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetTypeOption->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | RegularAssetTypeOption->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | RegularAssetTypeOption->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetTypeOption->Option_UnitOfMeasurement_Description | string | |\r\n", "operationId": "GetRegularAssetTypeOption", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Option Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Option", "schema": { "$ref": "#/definitions/GetRegularAssetTypeOptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Options": { "get": { "tags": [ "Regular Asset Type Option" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeOption->Id | integer | int64 |\r\n| version | RegularAssetTypeOption->Version | integer | int32 |\r\n| assetTypeId | RegularAssetTypeOption->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeOption->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeOption->AssetType_Description | string | |\r\n| optionId | RegularAssetTypeOption->Option_Id | integer | int64 |\r\n| optionCode | RegularAssetTypeOption->Option_Code | string | |\r\n| optionDescription | RegularAssetTypeOption->Option_Description | string | |\r\n| optionOptionCategoryCode | RegularAssetTypeOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetTypeOption->Option_OptionCategory_Description | string | |\r\n| optionDataType | RegularAssetTypeOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionUnitOfMeasurementCode | RegularAssetTypeOption->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetTypeOption->Option_UnitOfMeasurement_Description | string | |\r\n| optionLowerBounds | RegularAssetTypeOption->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetTypeOption->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | RegularAssetTypeOption->Option_AllowMultipleValues | boolean | |\r\n| createdOn | RegularAssetTypeOption->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeOption->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeOptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Option collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeOptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/{assetTypeId}/Options": { "get": { "tags": [ "Regular Asset Type Option" ], "summary": "Get a collection of Regular Asset Type Options for the Asset 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 | RegularAssetTypeOption->Id | integer | int64 |\r\n| version | RegularAssetTypeOption->Version | integer | int32 |\r\n| optionId | RegularAssetTypeOption->Option_Id | integer | int64 |\r\n| optionCode | RegularAssetTypeOption->Option_Code | string | |\r\n| optionDescription | RegularAssetTypeOption->Option_Description | string | |\r\n| optionOptionCategoryCode | RegularAssetTypeOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetTypeOption->Option_OptionCategory_Description | string | |\r\n| optionDataType | RegularAssetTypeOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionUnitOfMeasurementCode | RegularAssetTypeOption->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetTypeOption->Option_UnitOfMeasurement_Description | string | |\r\n| optionLowerBounds | RegularAssetTypeOption->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetTypeOption->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | RegularAssetTypeOption->Option_AllowMultipleValues | boolean | |\r\n", "operationId": "GetRegularAssetTypeOptionForAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "assetTypeId", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Option collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeOptionForAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Options/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Option" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeOption->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeOption->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeOption->Version | integer | int32 |\r\n| id | RegularAssetTypeOption->Id | integer | int64 |\r\n| assetTypeId | RegularAssetTypeOption->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeOption->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeOption->AssetType_Description | string | |\r\n| optionId | RegularAssetTypeOption->Option_Id | integer | int64 |\r\n| optionCode | RegularAssetTypeOption->Option_Code | string | |\r\n| optionDescription | RegularAssetTypeOption->Option_Description | string | |\r\n| optionDataType | RegularAssetTypeOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionLowerBounds | RegularAssetTypeOption->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetTypeOption->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | RegularAssetTypeOption->Option_AllowMultipleValues | boolean | |\r\n| optionOptionCategoryId | RegularAssetTypeOption->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | RegularAssetTypeOption->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetTypeOption->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | RegularAssetTypeOption->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | RegularAssetTypeOption->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetTypeOption->Option_UnitOfMeasurement_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTypeOption", "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 Regular Asset Type 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 Regular Asset Type Option collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeOptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/{id}": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Get a Regular Asset Type Responsibility 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 | RegularAssetTypeResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeResponsibility->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeResponsibility->Id | integer | int64 |\r\n| isActive | RegularAssetTypeResponsibility->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeResponsibility->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeResponsibility->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeResponsibility->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeResponsibility->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeResponsibility->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeResponsibility->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeResponsibility->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | RegularAssetTypeResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| notes | RegularAssetTypeResponsibility->Notes | string | |\r\n| recordType | RegularAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | RegularAssetTypeResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeResponsibility->Trade_Description | string | |\r\n", "operationId": "GetRegularAssetTypeResponsibility", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Responsibility", "schema": { "$ref": "#/definitions/GetRegularAssetTypeResponsibilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Update an existing Regular Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetTypeResponsibility->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| resourceId | Nullable | False | RegularAssetTypeResponsibility->Section_Id eq NULL AND RegularAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "UpdateRegularAssetTypeResponsibility", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeResponsibilityResourceActionRequest" } }, { "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 - Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Get a collection of Regular Asset Type Responsibility 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 | RegularAssetTypeResponsibility->Id | integer | int64 |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeResponsibility->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeResponsibility->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeResponsibility->RegularAssetType_Description | string | |\r\n| isActive | RegularAssetTypeResponsibility->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| recordType | RegularAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeResponsibility->Section_Description | string | |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeResponsibility->Resource_Code | string | |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeResponsibility->Trade_Description | string | |\r\n| developmentStatus | RegularAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeResponsibility->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeResponsibility->Notes | string | |\r\n| createdOn | RegularAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeResponsibilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeResponsibilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Create a new Regular Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeResponsibility->RegularAssetType_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetTypeResponsibility->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| resourceId | Nullable | False | RegularAssetTypeResponsibility->Section_Id eq NULL AND RegularAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "CreateRegularAssetTypeResponsibility", "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/CreateRegularAssetTypeResponsibilityResourceActionRequest" } }, { "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/RegularAssetTypes/{regularAssetTypeId}/Responsibilities": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Get a collection of Regular Asset Type Responsibility resources for the Regular Asset 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 | RegularAssetTypeResponsibility->Id | integer | int64 |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeResponsibility->Trade_Description | string | |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailFirstName | RegularAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| developmentStatus | RegularAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeResponsibility->IsInherited | boolean | |\r\n| notes | RegularAssetTypeResponsibility->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeResponsibilityForRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeId", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeResponsibilityForRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Lookups/LookupRegularAssetTypeResponsibilityChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Lookup the permission set for changing the Regular Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeResponsibilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Lookups/LookupRegularAssetTypeResponsibilityInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Lookup the permission set for creating the Regular Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeResponsibilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Lookups/LookupRegularAssetTypeResponsibilityRegularAssetType": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Lookup the Regular Asset Type for the Regular Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeResponsibilityRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeResponsibilityRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Lookups/LookupRegularAssetTypeResponsibilityResource": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Lookup the Resource for the Regular Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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| sectionCode | Resource->Section_Code | string | |\r\n", "operationId": "LookupRegularAssetTypeResponsibilityResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeResponsibilityResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Lookups/LookupRegularAssetTypeResponsibilityResourceWithTradeFilter": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Lookup the Resource for the Regular Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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| sectionId | Resource->Section_Id | integer | int64 |\r\n| sectionCode | Resource->Section_Code | string | |\r\n| idResourceTradeResourceTradeCode | Resource->*Id.ResourceTrade.Resource_Trade_Code | string | |\r\n", "operationId": "LookupRegularAssetTypeResponsibilityResourceWithTradeFilter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Lookups/LookupRegularAssetTypeResponsibilitySection": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Lookup the Section for the Regular Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeResponsibilitySection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeResponsibilitySectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Lookups/LookupRegularAssetTypeResponsibilityTrade": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Lookup the Trade for the Regular Asset Type Responsibility.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTypeResponsibilityTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeResponsibilityTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Get a collection of Regular Asset Type Responsibility 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 | RegularAssetTypeResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeResponsibility->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeResponsibility->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeResponsibility->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeResponsibility->Id | integer | int64 |\r\n| isActive | RegularAssetTypeResponsibility->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeResponsibility->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeResponsibility->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeResponsibility->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeResponsibility->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeResponsibility->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeResponsibility->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeResponsibility->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeResponsibility->InheritedFrom_Id | integer | int64 |\r\n| lastConfirmedChangeLogId | RegularAssetTypeResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| notes | RegularAssetTypeResponsibility->Notes | string | |\r\n| recordType | RegularAssetTypeResponsibility->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | RegularAssetTypeResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetTypeResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTypeResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeResponsibility->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeResponsibility->Section_Description | string | |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeResponsibility->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeResponsibility->Trade_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTypeResponsibility", "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 Regular Asset Type Responsibility 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 Regular Asset Type Responsibility collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeResponsibilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Responsibilities/Batch": { "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Create a new collection of Regular Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeId | RegularAssetTypeResponsibility->RegularAssetType_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeResponsibility->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetTypeResponsibility->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| resourceId | Nullable | False | RegularAssetTypeResponsibility->Section_Id eq NULL AND RegularAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeResponsibility", "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/BatchCreateRegularAssetTypeResponsibilityResourceActionRequest" } }, { "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 - Regular Asset Type Responsibility 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": [ "Regular Asset Type Responsibility" ], "summary": "Update a collection of existing Regular Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeResponsibility->Id | integer | int64 |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetTypeResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTypeResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTypeResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetTypeResponsibility->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| resourceId | Nullable | False | RegularAssetTypeResponsibility->Section_Id eq NULL AND RegularAssetTypeResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeResponsibility", "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/BatchUpdateRegularAssetTypeResponsibilityResourceActionRequest" } }, { "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 - Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Accept the Development Status for an existing Regular Asset Type Responsibility resource.", "description": "", "operationId": "AcceptRegularAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Responsibility resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Change the Development Status for an existing Regular Asset Type Responsibility resource.", "description": "", "operationId": "ChangeRegularAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Change the IsActive status for an existing Regular Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| isActive | RegularAssetTypeResponsibility->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": "ChangeRegularAssetTypeResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeResponsibilityIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Responsibilities/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Responsibility resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeResponsibility->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": "ChangeRegularAssetTypeResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Responsibilities/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Reject the Development Status for an existing Regular Asset Type Responsibility resource.", "description": "", "operationId": "RejectRegularAssetTypeResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Responsibility 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/RegularAssetTypes/Responsibilities/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeResponsibility->Id | integer | int64 |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| isActive | RegularAssetTypeResponsibility->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| 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": "BatchChangeRegularAssetTypeResponsibilityIsActive", "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/BatchChangeRegularAssetTypeResponsibilityIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Responsibilities/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Responsibility" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Responsibility resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeResponsibility->Id | integer | int64 |\r\n| version | RegularAssetTypeResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeResponsibility->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangeRegularAssetTypeResponsibilityPermissionTree", "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/BatchChangeRegularAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Rules/{id}": { "get": { "tags": [ "Regular Asset Type Rule" ], "summary": "Get a Regular Asset Type 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| isActive | RegularAssetTypeRule->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeRule->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeRule->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeRule->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeRule->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeRule->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeRule->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeRule->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeRule->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeRule->Version | integer | int32 |\r\n| id | RegularAssetTypeRule->Id | integer | int64 |\r\n| regularAssetTypeId | RegularAssetTypeRule->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeRule->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeRule->RegularAssetType_Description | string | |\r\n| ruleId | RegularAssetTypeRule->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeRule->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeRule->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeRule->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeRule->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeRule->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeRule->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeRule->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeRule", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Rule Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Rule", "schema": { "$ref": "#/definitions/GetRegularAssetTypeRuleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Rules": { "get": { "tags": [ "Regular Asset Type Rule" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeRule->Id | integer | int64 |\r\n| version | RegularAssetTypeRule->Version | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeRule->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeRule->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeRule->RegularAssetType_Description | string | |\r\n| ruleId | RegularAssetTypeRule->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeRule->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeRule->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeRule->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeRule->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeRule->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeRule->SequenceNumber | integer | int32 |\r\n| createdOn | RegularAssetTypeRule->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeRule->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeRuleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Rule collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeRuleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/{id}/Rules": { "get": { "tags": [ "Regular Asset Type Rule" ], "summary": "Get a collection of Regular Asset Type Rule resources for theRegular Asset 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 | RegularAssetTypeRule->Id | integer | int64 |\r\n| version | RegularAssetTypeRule->Version | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeRule->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeRule->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeRule->RegularAssetType_Description | string | |\r\n| ruleId | RegularAssetTypeRule->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeRule->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeRule->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeRule->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeRule->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeRule->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeRule->SequenceNumber | integer | int32 |\r\n| createdOn | RegularAssetTypeRule->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeRule->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeRuleForRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Rule collection", "schema": { "$ref": "#/definitions/GetRuleForRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Rules/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Rule" ], "summary": "Get a collection of Regular Asset Type 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| isActive | RegularAssetTypeRule->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeRule->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeRule->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeRule->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeRule->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeRule->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeRule->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeRule->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeRule->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeRule->Version | integer | int32 |\r\n| id | RegularAssetTypeRule->Id | integer | int64 |\r\n| regularAssetTypeId | RegularAssetTypeRule->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeRule->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeRule->RegularAssetType_Description | string | |\r\n| ruleId | RegularAssetTypeRule->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeRule->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeRule->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeRule->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeRule->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeRule->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeRule->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeRule->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetTypeRule", "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 Regular Asset Type 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 Regular Asset Type Rule collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeRuleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Spares/{id}": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Get a Regular Asset Type 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 | RegularAssetTypeSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeSpare->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeSpare->Id | integer | int64 |\r\n| isActive | RegularAssetTypeSpare->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeSpare->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeSpare->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeSpare->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeSpare->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMaterialMasterId | RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| isHistorical | RegularAssetTypeSpare->IsHistorical | boolean | |\r\n| materialMasterId | RegularAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeSpare->MaterialMaster_Description | string | |\r\n| notes | RegularAssetTypeSpare->Notes | string | |\r\n| recordType | RegularAssetTypeSpare->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetRegularAssetTypeSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Spare", "schema": { "$ref": "#/definitions/GetRegularAssetTypeSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Spare" ], "summary": "Update an existing Regular Asset Type 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 | RegularAssetTypeSpare->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | RegularAssetTypeSpare->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| isCritical | Nullable | False | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeSpareResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypes/Spares": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeSpare->Version | integer | int32 |\r\n| regularAssetTypeId | RegularAssetTypeSpare->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeSpare->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeSpare->RegularAssetType_Description | string | |\r\n| materialMasterId | RegularAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeSpare->MaterialMaster_Description | string | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| developmentStatus | RegularAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | RegularAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetTypeSpare->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTypeSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Spare collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Create a new Regular Asset Type 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| regularAssetTypeId | RegularAssetTypeSpare->RegularAssetType_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | RegularAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | RegularAssetTypeSpare->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| regularAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| isCritical | Required | True | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Required | True | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeSpare", "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/CreateRegularAssetTypeSpareResourceActionRequest" } }, { "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/RegularAssetTypes/{id}/Spares": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Get a collection of Regular Asset Type Spare resources for theRegular Asset 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 | RegularAssetTypeSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeSpare->MaterialMaster_Description | string | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| developmentStatus | RegularAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | RegularAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetTypeSpare->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTypeSpareForRegularAssetTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Regular Asset Type Spare collection", "schema": { "$ref": "#/definitions/GetSpareForRegularAssetTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Spares/Lookups/LookupRegularAssetTypeSpareChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Lookup the permission set for changing the Regular Asset Type 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": "LookupRegularAssetTypeSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Spares/Lookups/LookupRegularAssetTypeSpareInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Lookup the permission set for creating the Regular Asset Type 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": "LookupRegularAssetTypeSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Spares/Lookups/LookupRegularAssetTypeSpareMaterialMaster": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Lookup the Material Master for the Regular Asset Type 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": "LookupRegularAssetTypeSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Spares/Lookups/LookupRegularAssetTypeSpareRegularAssetType": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Lookup the Regular Asset Type for the Regular Asset Type 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 | RegularAssetType->Id | integer | int64 |\r\n| code | RegularAssetType->Code | string | |\r\n| description | RegularAssetType->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeSpareRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeSpareRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Spares/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Spare" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeSpare->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeSpare->Id | integer | int64 |\r\n| isActive | RegularAssetTypeSpare->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeSpare->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeId | RegularAssetTypeSpare->RegularAssetType_Id | integer | int64 |\r\n| regularAssetTypeCode | RegularAssetTypeSpare->RegularAssetType_Code | string | |\r\n| regularAssetTypeDescription | RegularAssetTypeSpare->RegularAssetType_Description | string | |\r\n| sequenceNumber | RegularAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMaterialMasterId | RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| isHistorical | RegularAssetTypeSpare->IsHistorical | boolean | |\r\n| materialMasterId | RegularAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeSpare->MaterialMaster_Description | string | |\r\n| notes | RegularAssetTypeSpare->Notes | string | |\r\n| recordType | RegularAssetTypeSpare->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "BatchGetRegularAssetTypeSpare", "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 Regular Asset Type 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 Regular Asset Type Spare collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypes/Spares/Batch": { "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Create a new collection of Regular Asset Type 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| regularAssetTypeId | RegularAssetTypeSpare->RegularAssetType_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | RegularAssetTypeSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | RegularAssetTypeSpare->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| regularAssetTypeId | Required | True | |\r\n| regularAssetTypeId | Nullable | False | |\r\n| regularAssetTypeId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| materialMasterId | Required | True | |\r\n| materialMasterId | Nullable | False | |\r\n| isCritical | Required | True | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Required | True | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeSpare", "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/BatchCreateRegularAssetTypeSpareResourceActionRequest" } }, { "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 - Regular Asset Type 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": [ "Regular Asset Type Spare" ], "summary": "Update a collection of existing Regular Asset Type 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 | RegularAssetTypeSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeSpare->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetTypeSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetTypeSpare->IsEmergency | boolean | |\r\n| notes | RegularAssetTypeSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isCritical | Nullable | False | |\r\n| isEmergency | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeSpare", "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/BatchUpdateRegularAssetTypeSpareResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypes/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Accept the Development Status for an existing Regular Asset Type Spare resource.", "description": "", "operationId": "AcceptRegularAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Spare resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Spare resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypes/Spares/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Spare resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypes/Spares/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Change the Development Status for an existing Regular Asset Type Spare resource.", "description": "", "operationId": "ChangeRegularAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypes/Spares/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Spare" ], "summary": "Change the IsActive status for an existing Regular Asset Type 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 | RegularAssetTypeSpare->Version | integer | int32 |\r\n| isActive | RegularAssetTypeSpare->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": "ChangeRegularAssetTypeSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeSpareIsActiveResourceActionRequest" } }, { "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/RegularAssetTypes/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Spare" ], "summary": "Change the PermissionTree for an existing Regular Asset Type 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 | RegularAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeSpare->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": "ChangeRegularAssetTypeSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypes/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Spare" ], "summary": "Reject the Development Status for an existing Regular Asset Type Spare resource.", "description": "", "operationId": "RejectRegularAssetTypeSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypes/Spares/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Spare" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type 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 | RegularAssetTypeSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeSpare->Version | integer | int32 |\r\n| isActive | RegularAssetTypeSpare->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| 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": "BatchChangeRegularAssetTypeSpareIsActive", "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/BatchChangeRegularAssetTypeSpareIsActiveResourceActionResourceActionRequest" } }, { "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/RegularAssetTypes/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Spare" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type 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 | RegularAssetTypeSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | > 0| |\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": "BatchChangeRegularAssetTypeSparePermissionTree", "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/BatchChangeRegularAssetTypeSparePermissionTreeResourceActionResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/{id}": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Get a Regular Asset Type 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| rulesLastChangedOn | RegularAssetTypeTask->RulesLastChangedOn | string | date-time |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeNearestRegularAssetTypeId | RegularAssetTypeTask->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| assetTypeTreePathId | RegularAssetTypeTask->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | RegularAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTypeTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTypeTask->Component_Description | string | |\r\n| componentQuantity | RegularAssetTypeTask->Component_Quantity | integer | int32 |\r\n| componentRecordType | RegularAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathId | RegularAssetTypeTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | RegularAssetTypeTask->Component_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| createdByUserId | RegularAssetTypeTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTask->PermissionTree_Description | string | |\r\n| allowConditions | RegularAssetTypeTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | RegularAssetTypeTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| daysToScheduleOn | RegularAssetTypeTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTypeTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTypeTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTypeTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTypeTask->DefaultInterval2_Description | string | |\r\n| derivedFromStandardTask | RegularAssetTypeTask->DerivedFromStandardTask | boolean | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTypeTask->DurationPerUnit | string | duration |\r\n| eventId | RegularAssetTypeTask->Event_Id | integer | int64 |\r\n| eventCode | RegularAssetTypeTask->Event_Code | string | |\r\n| eventDescription | RegularAssetTypeTask->Event_Description | string | |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| failedReasonRequired | RegularAssetTypeTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTypeTask->Importance_Id | integer | int64 |\r\n| importanceCode | RegularAssetTypeTask->Importance_Code | string | |\r\n| importanceDescription | RegularAssetTypeTask->Importance_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | RegularAssetTypeTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | RegularAssetTypeTask->InheritedFrom_Description | string | |\r\n| inheritedFromRecordType | RegularAssetTypeTask->InheritedFrom_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| inheritedFromAssetTypeId | RegularAssetTypeTask->InheritedFrom_AssetType_Id | integer | int64 |\r\n| inheritedFromAssetTypeCode | RegularAssetTypeTask->InheritedFrom_AssetType_Code | string | |\r\n| inheritedFromAssetTypeDescription | RegularAssetTypeTask->InheritedFrom_AssetType_Description | string | |\r\n| inspectionType | RegularAssetTypeTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1SchedulingKind | RegularAssetTypeTask->IntervalType1_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| intervalType1Code | RegularAssetTypeTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTypeTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTypeTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTypeTask->IntervalType2_Description | string | |\r\n| intervalType2SchedulingKind | RegularAssetTypeTask->IntervalType2_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isDualScheduling | RegularAssetTypeTask->IsDualScheduling | boolean | |\r\n| isHistorical | RegularAssetTypeTask->IsHistorical | boolean | |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isPausedForScheduling | RegularAssetTypeTask->IsPausedForScheduling | boolean | |\r\n| isStatutory | RegularAssetTypeTask->IsStatutory | boolean | |\r\n| isSuppressed | RegularAssetTypeTask->IsSuppressed | boolean | |\r\n| isSuppressor | RegularAssetTypeTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | RegularAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTypeTask->LongDescription | string | |\r\n| machineState | RegularAssetTypeTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| monitoringPointTypeId | RegularAssetTypeTask->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | RegularAssetTypeTask->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | RegularAssetTypeTask->MonitoringPointType_Description | string | |\r\n| motionType | RegularAssetTypeTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| pausedReason | RegularAssetTypeTask->PausedReason | string | |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| recordType | RegularAssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| responsibleSectionId | RegularAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | RegularAssetTypeTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | RegularAssetTypeTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | RegularAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | RegularAssetTypeTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceContactDetailId | RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | RegularAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | RegularAssetTypeTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | RegularAssetTypeTask->ResponsibleTrade_Description | string | |\r\n| schedulingMethod | RegularAssetTypeTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | RegularAssetTypeTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | RegularAssetTypeTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | RegularAssetTypeTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | RegularAssetTypeTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | RegularAssetTypeTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | RegularAssetTypeTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | RegularAssetTypeTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | RegularAssetTypeTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | RegularAssetTypeTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | RegularAssetTypeTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | RegularAssetTypeTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | RegularAssetTypeTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | RegularAssetTypeTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | RegularAssetTypeTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | RegularAssetTypeTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | RegularAssetTypeTask->TaskClassification8_Description | string | |\r\n| taskRollUpPointId | RegularAssetTypeTask->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAssetTypeTask->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAssetTypeTask->TaskRollUpPoint_Description | string | |\r\n| totalDowntime | RegularAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTypeTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTypeTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | RegularAssetTypeTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | RegularAssetTypeTask->TypeOfWork_Description | string | |\r\n", "operationId": "GetRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task" ], "summary": "Update an existing Regular Asset Type 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 | RegularAssetTypeTask->Version | integer | int32 |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | RegularAssetTypeTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTypeTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTypeTask->DurationPerUnit | string | duration |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| eventId | RegularAssetTypeTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | RegularAssetTypeTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTypeTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTypeTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTypeTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| isStatutory | RegularAssetTypeTask->IsStatutory | boolean | |\r\n| isPausedForScheduling | RegularAssetTypeTask->IsPausedForScheduling | boolean | |\r\n| labourDurationCalculationType | RegularAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTypeTask->LongDescription | string | |\r\n| machineState | RegularAssetTypeTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| monitoringPointTypeId | RegularAssetTypeTask->MonitoringPointType_Id | integer | int64 |\r\n| motionType | RegularAssetTypeTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| pausedReason | RegularAssetTypeTask->PausedReason | string | |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTypeTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| totalDowntime | RegularAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTypeTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTypeTask->TypeOfWork_Id | integer | int64 |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTypeTask->TaskRollUpPoint_Id | integer | int64 |\r\n| allowConditions | RegularAssetTypeTask->AllowConditions | 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| alternativeDescription | System Generated | true | If no value specified |\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 | Read-only | True | RegularAssetTypeTask->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| componentId | Min Value | > 0| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTypeTask->IsDualScheduling eq false |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | RegularAssetTypeTask->IsInherited eq true |\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| excludeWhenAllFollowUpTaskRulesFail | Nullable | False | |\r\n| excludeWhenSpecialResourceRulesFail | Nullable | False | |\r\n| excludeWhenAllSpareRulesFail | Nullable | False | |\r\n| failedReasonRequired | Nullable | False | RegularAssetTypeTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| intervalType2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | RegularAssetTypeTask->IsDualScheduling eq false |\r\n| isDualScheduling | Nullable | False | |\r\n| isInspection | Nullable | False | |\r\n| inspectionType | Nullable | False | RegularAssetTypeTask->IsInspection eq TRUE |\r\n| isNonUsageBasedReadingRequired | Nullable | False | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| monitoringPointTypeId | Nullable | False | RegularAssetTypeTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTypeTask->InspectionType eq 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTypeTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTypeTask->InspectionType ne 'ManualMonitoring' |\r\n| motionType | Nullable | False | |\r\n| pausedReason | Nullable | False | RegularAssetTypeTask->IsPausedForScheduling eq TRUE |\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| taskRollUpPointId | Min Value | > 0| |\r\n| allowConditions | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| isInherited | RegularAssetTypeTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| developmentStatus | RegularAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeRecordType | RegularAssetTypeTask->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeTreePathItems | RegularAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTypeTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTypeTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTypeTask->Component_TreePathItems | array | array |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| importanceCode | RegularAssetTypeTask->Importance_Code | string | |\r\n| rulesLastChangedOn | RegularAssetTypeTask->RulesLastChangedOn | string | date-time |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTypeTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTypeTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTypeTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTypeTask->IntervalType2_Description | string | |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | RegularAssetTypeTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | RegularAssetTypeTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | RegularAssetTypeTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | RegularAssetTypeTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | RegularAssetTypeTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | RegularAssetTypeTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | RegularAssetTypeTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | RegularAssetTypeTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | RegularAssetTypeTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | RegularAssetTypeTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | RegularAssetTypeTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | RegularAssetTypeTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | RegularAssetTypeTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | RegularAssetTypeTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | RegularAssetTypeTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | RegularAssetTypeTask->TaskClassification8_Description | string | |\r\n", "operationId": "GetRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Create a new Regular Asset Type 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 | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| autoCalculateDowntimePerUnit | RegularAssetTypeTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTypeTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTypeTask->DurationPerUnit | string | duration |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| eventId | RegularAssetTypeTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | RegularAssetTypeTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTypeTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTypeTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTypeTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| isStatutory | RegularAssetTypeTask->IsStatutory | boolean | |\r\n| isPausedForScheduling | RegularAssetTypeTask->IsPausedForScheduling | boolean | |\r\n| labourDurationCalculationType | RegularAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTypeTask->LongDescription | string | |\r\n| monitoringPointTypeId | RegularAssetTypeTask->MonitoringPointType_Id | integer | int64 |\r\n| motionType | RegularAssetTypeTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| machineState | RegularAssetTypeTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| pausedReason | RegularAssetTypeTask->PausedReason | string | |\r\n| permissionTreeId | RegularAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTypeTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| totalDowntime | RegularAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTypeTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTypeTask->TypeOfWork_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTypeTask->TaskRollUpPoint_Id | integer | int64 |\r\n| allowConditions | RegularAssetTypeTask->AllowConditions | 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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| autoCalculateDowntimePerUnit | Required | True | |\r\n| autoCalculateDowntimePerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Required | True | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Required | True | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDuration | Required | True | |\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| componentId | Min Value | > 0| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTypeTask->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| excludeWhenAllFollowUpTaskRulesFail | Nullable | False | |\r\n| excludeWhenSpecialResourceRulesFail | Nullable | False | |\r\n| excludeWhenAllSpareRulesFail | Nullable | False | |\r\n| failedReasonRequired | Nullable | False | RegularAssetTypeTask->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 | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | RegularAssetTypeTask->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| inspectionType | Nullable | False | RegularAssetTypeTask->IsInspection eq TRUE |\r\n| isNonUsageBasedReadingRequired | Required | True | |\r\n| isNonUsageBasedReadingRequired | 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| monitoringPointTypeId | Nullable | False | RegularAssetTypeTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTypeTask->InspectionType eq 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTypeTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTypeTask->InspectionType ne 'ManualMonitoring' |\r\n| motionType | Required | True | |\r\n| motionType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| pausedReason | Nullable | False | RegularAssetTypeTask->IsPausedForScheduling eq TRUE |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Required | True | |\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| taskRollUpPointId | Min Value | > 0| |\r\n| allowConditions | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTask", "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/CreateRegularAssetTypeTaskResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Lookups/LookupCreateFromStandardTaskAssetTypeComponentFromAssetType": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Asset Type Component for the Regular Asset Type 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 | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| assetTypeId | AssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | AssetTypeComponent->AssetType_Description | string | |\r\n", "operationId": "LookupCreateFromStandardTaskAssetTypeComponentFromAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/StandardTaskAssetTypeComponentFromAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupCreateFromStandardTaskAssetTypeComponent": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Asset Type Component for the Regular Asset Type 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 | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| assetTypeId | AssetTypeComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetTypeComponent->AssetType_Code | string | |\r\n| assetTypeDescription | AssetTypeComponent->AssetType_Description | string | |\r\n", "operationId": "LookupCreateFromStandardTaskAssetTypeComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/StandardTaskAssetTypeComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupCreateFromStandardTaskAssetType": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Asset Type for the Regular Asset Type 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 | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n", "operationId": "LookupCreateFromStandardTaskAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/StandardTaskAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskAssetType": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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 | AssetType->Id | integer | int64 |\r\n| code | AssetType->Code | string | |\r\n| description | AssetType->Description | string | |\r\n| recordType | AssetType->RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupRegularAssetTypeTaskAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the permission set for changing the Regular Asset Type 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": "LookupRegularAssetTypeTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskComponent": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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 | AssetTypeComponent->Id | integer | int64 |\r\n| code | AssetTypeComponent->Code | string | |\r\n| description | AssetTypeComponent->Description | string | |\r\n| quantity | AssetTypeComponent->Quantity | integer | int32 |\r\n| recordType | AssetTypeComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupRegularAssetTypeTaskComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Type Component collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskDefaultInterval1All": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Task Interval for the Regular Asset Type 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": "LookupRegularAssetTypeTaskDefaultInterval1All", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskDefaultInterval1AllLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskDefaultInterval1": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Task Interval for the Regular Asset Type 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": "LookupRegularAssetTypeTaskDefaultInterval1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskDefaultInterval1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskDefaultInterval2All": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Task Interval for the Regular Asset Type 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": "LookupRegularAssetTypeTaskDefaultInterval2All", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskDefaultInterval2AllLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskDefaultInterval2": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Task Interval for the Regular Asset Type 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": "LookupRegularAssetTypeTaskDefaultInterval2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskDefaultInterval2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskEvent": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Event for the Regular Asset Type 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": "LookupRegularAssetTypeTaskEvent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskImportance": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Task Importance for the Regular Asset Type 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": "LookupRegularAssetTypeTaskImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the permission set for creating the Regular Asset Type 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": "LookupRegularAssetTypeTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskIntervalType1": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Task Interval Type for the Regular Asset Type 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": "LookupRegularAssetTypeTaskIntervalType1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskIntervalType1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskIntervalType2": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Task Interval Type for the Regular Asset Type 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": "LookupRegularAssetTypeTaskIntervalType2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskIntervalType2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskMonitoringPointType": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Monitoring Point Type for the Regular Asset Type 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 | MonitoringPointType->Id | integer | int64 |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskMonitoringPointType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Monitoring Point Type collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskMonitoringPointTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskResponsibleSection": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Section for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResponsibleSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResponsibleSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskResponsibleStaffMemberResource": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Resource for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResponsibleStaffMemberResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskResponsibleTrade": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Trade for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResponsibleTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResponsibleTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification1": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification2": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification3": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification3", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification3LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification4": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification4", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification4LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification5": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification5", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification5LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification6": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification6", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification6LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification7": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification7", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification7LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskClassification8": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskClassification8", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskClassification8LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTaskRollUpPoint": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Lookups/LookupRegularAssetTypeTaskTypeOfWork": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Lookup the Type of Work for the Regular Asset Type 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": "LookupRegularAssetTypeTaskTypeOfWork", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskTypeOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task" ], "summary": "Get a collection of Regular Asset Type 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| rulesLastChangedOn | RegularAssetTypeTask->RulesLastChangedOn | string | date-time |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n| assetTypeNearestRegularAssetTypeId | RegularAssetTypeTask->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n| assetTypeTreePathId | RegularAssetTypeTask->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | RegularAssetTypeTask->AssetType_TreePathItems | array | array |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTypeTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTypeTask->Component_Description | string | |\r\n| componentQuantity | RegularAssetTypeTask->Component_Quantity | integer | int32 |\r\n| componentRecordType | RegularAssetTypeTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathId | RegularAssetTypeTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | RegularAssetTypeTask->Component_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetTypeTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| createdByUserId | RegularAssetTypeTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTask->PermissionTree_Description | string | |\r\n| allowConditions | RegularAssetTypeTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | RegularAssetTypeTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| daysToScheduleOn | RegularAssetTypeTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTypeTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTypeTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTypeTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTypeTask->DefaultInterval2_Description | string | |\r\n| derivedFromStandardTask | RegularAssetTypeTask->DerivedFromStandardTask | boolean | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTypeTask->DurationPerUnit | string | duration |\r\n| eventId | RegularAssetTypeTask->Event_Id | integer | int64 |\r\n| eventCode | RegularAssetTypeTask->Event_Code | string | |\r\n| eventDescription | RegularAssetTypeTask->Event_Description | string | |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| failedReasonRequired | RegularAssetTypeTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTypeTask->Importance_Id | integer | int64 |\r\n| importanceCode | RegularAssetTypeTask->Importance_Code | string | |\r\n| importanceDescription | RegularAssetTypeTask->Importance_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | RegularAssetTypeTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | RegularAssetTypeTask->InheritedFrom_Description | string | |\r\n| inheritedFromRecordType | RegularAssetTypeTask->InheritedFrom_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| inheritedFromAssetTypeId | RegularAssetTypeTask->InheritedFrom_AssetType_Id | integer | int64 |\r\n| inheritedFromAssetTypeCode | RegularAssetTypeTask->InheritedFrom_AssetType_Code | string | |\r\n| inheritedFromAssetTypeDescription | RegularAssetTypeTask->InheritedFrom_AssetType_Description | string | |\r\n| inspectionType | RegularAssetTypeTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1SchedulingKind | RegularAssetTypeTask->IntervalType1_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| intervalType1Code | RegularAssetTypeTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTypeTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTypeTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTypeTask->IntervalType2_Description | string | |\r\n| intervalType2SchedulingKind | RegularAssetTypeTask->IntervalType2_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isDualScheduling | RegularAssetTypeTask->IsDualScheduling | boolean | |\r\n| isHistorical | RegularAssetTypeTask->IsHistorical | boolean | |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isPausedForScheduling | RegularAssetTypeTask->IsPausedForScheduling | boolean | |\r\n| isStatutory | RegularAssetTypeTask->IsStatutory | boolean | |\r\n| isSuppressed | RegularAssetTypeTask->IsSuppressed | boolean | |\r\n| isSuppressor | RegularAssetTypeTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | RegularAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTypeTask->LongDescription | string | |\r\n| machineState | RegularAssetTypeTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| monitoringPointTypeId | RegularAssetTypeTask->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | RegularAssetTypeTask->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | RegularAssetTypeTask->MonitoringPointType_Description | string | |\r\n| motionType | RegularAssetTypeTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| pausedReason | RegularAssetTypeTask->PausedReason | string | |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| recordType | RegularAssetTypeTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| responsibleSectionId | RegularAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | RegularAssetTypeTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | RegularAssetTypeTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | RegularAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | RegularAssetTypeTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceContactDetailId | RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | RegularAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | RegularAssetTypeTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | RegularAssetTypeTask->ResponsibleTrade_Description | string | |\r\n| schedulingMethod | RegularAssetTypeTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | RegularAssetTypeTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | RegularAssetTypeTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | RegularAssetTypeTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | RegularAssetTypeTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | RegularAssetTypeTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | RegularAssetTypeTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | RegularAssetTypeTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | RegularAssetTypeTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | RegularAssetTypeTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | RegularAssetTypeTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | RegularAssetTypeTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | RegularAssetTypeTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | RegularAssetTypeTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | RegularAssetTypeTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | RegularAssetTypeTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | RegularAssetTypeTask->TaskClassification8_Description | string | |\r\n| taskRollUpPointId | RegularAssetTypeTask->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAssetTypeTask->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAssetTypeTask->TaskRollUpPoint_Description | string | |\r\n| totalDowntime | RegularAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTypeTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTypeTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | RegularAssetTypeTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | RegularAssetTypeTask->TypeOfWork_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTypeTask", "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 Regular Asset Type 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 Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Batch": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Create a new collection of Regular Asset Type 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 | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| autoCalculateDowntimePerUnit | RegularAssetTypeTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTypeTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTypeTask->DurationPerUnit | string | duration |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| eventId | RegularAssetTypeTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | RegularAssetTypeTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTypeTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTypeTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTypeTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| isStatutory | RegularAssetTypeTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | RegularAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTypeTask->LongDescription | string | |\r\n| monitoringPointTypeId | RegularAssetTypeTask->MonitoringPointType_Id | integer | int64 |\r\n| motionType | RegularAssetTypeTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| machineState | RegularAssetTypeTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| permissionTreeId | RegularAssetTypeTask->PermissionTree_Id | integer | int64 |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTypeTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| totalDowntime | RegularAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTypeTask->TotalDuration | string | duration |\r\n| isPausedForScheduling | RegularAssetTypeTask->IsPausedForScheduling | boolean | |\r\n| pausedReason | RegularAssetTypeTask->PausedReason | string | |\r\n| typeOfWorkId | RegularAssetTypeTask->TypeOfWork_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTypeTask->TaskRollUpPoint_Id | integer | int64 |\r\n| allowConditions | RegularAssetTypeTask->AllowConditions | 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| alternativeDescription | System Generated | true | If no value specified |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| assetTypeId | Min Value | > 0| |\r\n| autoCalculateDowntimePerUnit | Required | True | |\r\n| autoCalculateDowntimePerUnit | Nullable | False | |\r\n| autoCalculateTotalDowntime | Required | True | |\r\n| autoCalculateTotalDowntime | Nullable | False | |\r\n| autoCalculateDurationPerUnit | Required | True | |\r\n| autoCalculateDurationPerUnit | Nullable | False | |\r\n| autoCalculateTotalDuration | Required | True | |\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| componentId | Min Value | > 0| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTypeTask->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| excludeWhenAllFollowUpTaskRulesFail | Nullable | False | |\r\n| excludeWhenSpecialResourceRulesFail | Nullable | False | |\r\n| excludeWhenAllSpareRulesFail | Nullable | False | |\r\n| failedReasonRequired | Nullable | False | RegularAssetTypeTask->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 | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | RegularAssetTypeTask->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| inspectionType | Nullable | False | RegularAssetTypeTask->IsInspection eq TRUE |\r\n| isNonUsageBasedReadingRequired | Required | True | |\r\n| isNonUsageBasedReadingRequired | 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| monitoringPointTypeId | Nullable | False | RegularAssetTypeTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTypeTask->InspectionType eq 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTypeTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTypeTask->InspectionType ne 'ManualMonitoring' |\r\n| motionType | Required | True | |\r\n| motionType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Required | True | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n| pausedReason | Nullable | False | RegularAssetTypeTask->IsPausedForScheduling eq TRUE |\r\n| typeOfWorkId | Required | True | |\r\n| typeOfWorkId | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| allowConditions | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTask", "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/BatchCreateRegularAssetTypeTaskResourceActionRequest" } }, { "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 - Regular Asset Type 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": [ "Regular Asset Type Task" ], "summary": "Update a collection of existing Regular Asset Type 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| autoCalculateDowntimePerUnit | RegularAssetTypeTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTypeTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTypeTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTypeTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTypeTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTypeTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTypeTask->DurationPerUnit | string | duration |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| eventId | RegularAssetTypeTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | RegularAssetTypeTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTypeTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTypeTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTypeTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTypeTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isNonUsageBasedReadingRequired | RegularAssetTypeTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| isStatutory | RegularAssetTypeTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | RegularAssetTypeTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTypeTask->LongDescription | string | |\r\n| monitoringPointTypeId | RegularAssetTypeTask->MonitoringPointType_Id | integer | int64 |\r\n| motionType | RegularAssetTypeTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTypeTask->Notes | string | |\r\n| machineState | RegularAssetTypeTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTypeTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| totalDowntime | RegularAssetTypeTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTypeTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTypeTask->TypeOfWork_Id | integer | int64 |\r\n| isPausedForScheduling | RegularAssetTypeTask->IsPausedForScheduling | boolean | |\r\n| pausedReason | RegularAssetTypeTask->PausedReason | string | |\r\n| taskRollUpPointId | RegularAssetTypeTask->TaskRollUpPoint_Id | integer | int64 |\r\n| allowConditions | RegularAssetTypeTask->AllowConditions | 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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| alternativeDescription | System Generated | true | If no value specified |\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 | Read-only | True | RegularAssetTypeTask->IsInherited eq true |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| componentId | Min Value | > 0| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTypeTask->IsDualScheduling eq false |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | RegularAssetTypeTask->IsInherited eq true |\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| excludeWhenAllFollowUpTaskRulesFail | Nullable | False | |\r\n| excludeWhenSpecialResourceRulesFail | Nullable | False | |\r\n| excludeWhenAllSpareRulesFail | Nullable | False | |\r\n| failedReasonRequired | Nullable | False | RegularAssetTypeTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| intervalType2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | RegularAssetTypeTask->IsDualScheduling eq false |\r\n| isDualScheduling | Nullable | False | |\r\n| isInspection | Nullable | False | |\r\n| inspectionType | Nullable | False | RegularAssetTypeTask->IsInspection eq TRUE |\r\n| isNonUsageBasedReadingRequired | Nullable | False | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| monitoringPointTypeId | Nullable | False | RegularAssetTypeTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTypeTask->InspectionType eq 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTypeTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTypeTask->InspectionType ne 'ManualMonitoring' |\r\n| motionType | Nullable | False | |\r\n| machineState | 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| pausedReason | Nullable | False | RegularAssetTypeTask->IsPausedForScheduling eq TRUE |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| allowConditions | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTask", "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/BatchUpdateRegularAssetTypeTaskResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/Batch/{ids}/BreakLinkToStandardTask": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Batch break Regular Asset Type Tasks link to Standard Tasks.", "description": "", "operationId": "BatchBreakRegularAssetTypeTaskLinkToStandardTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/{id}/BreakLinkToStandardTask": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Break Regular Asset Type Task link to Standard Task.", "description": "", "operationId": "BreakRegularAssetTypeTaskLinkToStandardTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Change the Development Status for an existing Regular Asset Type Task resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task" ], "summary": "Change the IsActive status for an existing Regular Asset Type 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 | RegularAssetTypeTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTask->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": "ChangeRegularAssetTypeTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task" ], "summary": "Change the PermissionTree for an existing Regular Asset Type 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 | RegularAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTask->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": "ChangeRegularAssetTypeTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/CreateFromStandardTask": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Create Regular Asset Type Task from the Regular Asset Type Task.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| assetTypeId | CreateRegularAssetTypeTaskFromStandardTask->AssetType_Id | integer | int64 |\r\n| assetTypeComponentId | CreateRegularAssetTypeTaskFromStandardTask->AssetTypeComponent_Id | integer | int64 |\r\n| permissionTreeId | CreateRegularAssetTypeTaskFromStandardTask->PermissionTree_Id | integer | int64 |\r\n| breakStandardTaskLink | CreateRegularAssetTypeTaskFromStandardTask->BreakStandardTaskLink | boolean | |\r\n| keepStandardTaskCode | CreateRegularAssetTypeTaskFromStandardTask->KeepStandardTaskCode | boolean | |\r\n| standardTaskIds | CreateRegularAssetTypeTaskFromStandardTask->StandardTaskIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| standardTaskIds | Required | True | |\r\n| standardTaskIds | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskFromStandardTask", "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/CreateRegularAssetTypeTaskFromStandardTaskResourceActionRequest" } }, { "$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/RegularAssetTypeTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTask->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| 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": "BatchChangeRegularAssetTypeTaskIsActive", "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/BatchChangeRegularAssetTypeTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTask->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| id | Min Value | >= 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskPermissionTree", "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/BatchChangeRegularAssetTypeTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/MatchBatch": { "patch": { "tags": [ "Regular Asset Type Task" ], "summary": "Update a collection of existing Regular Asset Type Task resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTask->Version | integer | int32 |\r\n| allowConditions | RegularAssetTypeTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTypeTask->AlternativeDescription | string | |\r\n| daysToScheduleOn | RegularAssetTypeTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTypeTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTypeTask->DefaultInterval2_Id | integer | int64 |\r\n| importanceId | RegularAssetTypeTask->Importance_Id | integer | int64 |\r\n| typeOfWorkId | RegularAssetTypeTask->TypeOfWork_Id | integer | int64 |\r\n| eventId | RegularAssetTypeTask->Event_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTypeTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTypeTask->IsDualScheduling | boolean | |\r\n| isMandatory | RegularAssetTypeTask->IsMandatory | boolean | |\r\n| isPausedForScheduling | RegularAssetTypeTask->IsPausedForScheduling | boolean | |\r\n| motionType | RegularAssetTypeTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| machineState | RegularAssetTypeTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| isStatutory | RegularAssetTypeTask->IsStatutory | boolean | |\r\n| pausedReason | RegularAssetTypeTask->PausedReason | string | |\r\n| responsibleStaffMemberResourceId | RegularAssetTypeTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTypeTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTypeTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTypeTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTypeTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTypeTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTypeTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTypeTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTypeTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTypeTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTypeTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTypeTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTypeTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTypeTask->TaskRollUpPoint_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 | Min Value | >= 0| |\r\n| id | Min Value | >= 0| |\r\n| allowConditions | Nullable | False | |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| daysToScheduleOn | Nullable | False | |\r\n| daysToScheduleOn | Nullable | False | |\r\n| defaultInterval1Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTypeTask->IsDualScheduling eq false |\r\n| importanceId | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| intervalType2Id | Nullable | False | RegularAssetTypeTask->IsDualScheduling eq true |\r\n| intervalType2Id | Nullable | True | RegularAssetTypeTask->IsDualScheduling eq false |\r\n| isDualScheduling | Nullable | False | |\r\n| motionType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| pausedReason | Nullable | False | RegularAssetTypeTask->IsPausedForScheduling eq TRUE |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdateRegularAssetTypeTask", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateRegularAssetTypeTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type 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/RegularAssetTypeTasks/Attributes/{id}": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Get a Regular Asset Type Task Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Description | string | |\r\n| inheritedFrom | RegularAssetTypeTaskAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskAttribute | RegularAssetTypeTaskAttribute->InheritedFromStandardTaskAttribute | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeTaskAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTypeTaskAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTypeTaskAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeTaskAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| id | RegularAssetTypeTaskAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTypeTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeTaskAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTypeTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTypeTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTypeTaskAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTypeTaskAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeTaskAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n", "operationId": "GetRegularAssetTypeTaskAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Attribute", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Update an existing Regular Asset Type Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Task Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/{regularAssetTypeTaskId}/Attributes": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Get a collection of Regular Asset Type Task Attribute resources for the Regular Asset Type 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 | RegularAssetTypeTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetTypeTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeTaskAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTypeTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeAllowAnyValue | RegularAssetTypeTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeTaskAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n| notes | RegularAssetTypeTaskAttribute->Notes | string | |\r\n| createdOn | RegularAssetTypeTaskAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeTaskAttribute->ModifiedOn | string | date-time |\r\n| lastConfirmedOn | RegularAssetTypeTaskAttribute->LastConfirmedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeTaskAttributeCollectionForRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeTaskId", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskAttributeCollectionForRegularAssetTypeTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Get a collection of Regular Asset Type Task Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAlternativeDescription | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetTypeTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeTaskAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTypeTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeAllowAnyValue | RegularAssetTypeTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeTaskAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n| notes | RegularAssetTypeTaskAttribute->Notes | string | |\r\n| createdOn | RegularAssetTypeTaskAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeTaskAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeTaskAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Create a new Regular Asset Type Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Id | integer | int64 |\r\n| attributeId | RegularAssetTypeTaskAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAttribute->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskAttribute", "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/CreateRegularAssetTypeTaskAttributeResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Attributes/Lookups/LookupRegularAssetTypeTaskAttributeAllowedValue": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Regular Asset Type Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupRegularAssetTypeTaskAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes/Lookups/LookupRegularAssetTypeTaskAttribute": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Lookup the Attribute for the Regular Asset Type Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes/Lookups/LookupRegularAssetTypeTaskAttributeChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Lookup the permission set for changing the Regular Asset Type Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes/Lookups/LookupRegularAssetTypeTaskAttributeInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Lookup the permission set for creating the Regular Asset Type Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes/Lookups/LookupRegularAssetTypeTaskAttributeTask": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Lookup the Regular Asset Type Task Attribute for the Regular Asset Type Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskAttributeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskAttributeRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Get a collection of Regular Asset Type Task Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Description | string | |\r\n| inheritedFrom | RegularAssetTypeTaskAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskAttribute | RegularAssetTypeTaskAttribute->InheritedFromStandardTaskAttribute | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeTaskAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTypeTaskAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTypeTaskAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTypeTaskAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTypeTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| id | RegularAssetTypeTaskAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTypeTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTypeTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTypeTaskAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTypeTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTypeTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTypeTaskAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTypeTaskAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTypeTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTypeTaskAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRegularAssetTypeTaskAttribute", "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 Regular Asset Type Task Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Attribute collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes/Batch": { "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Create a new collection of Regular Asset Type Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Id | integer | int64 |\r\n| attributeId | RegularAssetTypeTaskAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAttribute->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskAttribute", "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/BatchCreateRegularAssetTypeTaskAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Task Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Update a collection of existing Regular Asset Type Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| value | RegularAssetTypeTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTypeTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAttribute->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskAttribute", "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/BatchUpdateRegularAssetTypeTaskAttributeResourceActionRequest" } }, { "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 - Regular Asset Type Task Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Attribute resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Attribute 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/RegularAssetTypeTasks/Attributes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Attribute resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Attribute 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/RegularAssetTypeTasks/Attributes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Attribute resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Attribute 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/RegularAssetTypeTasks/Attributes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Attribute resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Attribute 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/RegularAssetTypeTasks/Attributes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Attribute resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Attribute 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/RegularAssetTypeTasks/Attributes/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskAttribute->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": "ChangeRegularAssetTypeTaskAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAttributeIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskAttribute->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": "ChangeRegularAssetTypeTaskAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Attribute resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Attribute 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/RegularAssetTypeTasks/Attributes/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskAttribute->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": "BatchChangeRegularAssetTypeTaskAttributeIsActive", "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/BatchChangeRegularAssetTypeTaskAttributeIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskAttribute->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| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskAttributePermissionTree", "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/BatchChangeRegularAssetTypeTaskAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/AuxiliaryTasks/{id}": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Get a Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskAuxiliaryTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskAuxiliaryTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskAuxiliaryTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskAuxiliaryTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskAuxiliaryTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskAuxiliaryTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskAuxiliaryTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromAuxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Id | integer | int64 |\r\n| inheritedFromAuxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| notes | RegularAssetTypeTaskAuxiliaryTask->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeTaskAuxiliaryTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Auxiliary Task", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskAuxiliaryTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Update an existing Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAuxiliaryTask->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| auxiliaryType | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskAuxiliaryTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/{id}/AuxiliaryTasks": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Get a collection of Regular Asset Type Task Auxiliary Task for the Regular Asset Type 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 | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| developmentStatus | RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetTypeTaskAuxiliaryTask->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTypeTaskAuxiliaryTaskForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Auxiliary Task collection", "schema": { "$ref": "#/definitions/GetAuxiliaryTaskForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/AuxiliaryTasks": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Get a collection of Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Description | string | |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| developmentStatus | RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetTypeTaskAuxiliaryTask->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTypeTaskAuxiliaryTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Auxiliary Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskAuxiliaryTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Create a new Regular Asset Type Task Auxiliary 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| regularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAuxiliaryTask->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| auxiliaryTaskId | Required | True | |\r\n| auxiliaryTaskId | Nullable | False | |\r\n| auxiliaryTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| auxiliaryType | Required | True | |\r\n| auxiliaryType | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskAuxiliaryTask", "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/CreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest" } }, { "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/RegularAssetTypeTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTypeTaskAuxiliaryTaskAuxiliaryTask": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Lookup the Auxiliary Asset Type Task for the Regular Asset Type Task Auxiliary 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 | AuxiliaryAssetTypeTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTypeTask->Code | string | |\r\n| description | AuxiliaryAssetTypeTask->Description | string | |\r\n| auxiliaryTaskType | AuxiliaryAssetTypeTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| assetTypeNearestRegularAssetTypeId | AuxiliaryAssetTypeTask->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskAuxiliaryTaskAuxiliaryTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Auxiliary Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTypeTaskAuxiliaryTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Lookup the permission set for changing the Regular Asset Type Task Auxiliary 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": "LookupRegularAssetTypeTaskAuxiliaryTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTypeTaskAuxiliaryTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Lookup the permission set for creating the Regular Asset Type Task Auxiliary 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": "LookupRegularAssetTypeTaskAuxiliaryTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTypeTaskAuxiliaryTaskRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| assetTypeNearestRegularAssetTypeId | RegularAssetTypeTask->AssetType_NearestRegularAssetType_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskAuxiliaryTaskRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskAuxiliaryTaskRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/AuxiliaryTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Get a collection of Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskAuxiliaryTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskAuxiliaryTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskAuxiliaryTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskAuxiliaryTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskAuxiliaryTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskAuxiliaryTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskAuxiliaryTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromAuxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Id | integer | int64 |\r\n| inheritedFromAuxiliaryTaskCode | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| notes | RegularAssetTypeTaskAuxiliaryTask->Notes | string | |\r\n", "operationId": "BatchGetRegularAssetTypeTaskAuxiliaryTask", "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 Regular Asset Type Task Auxiliary 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 Regular Asset Type Task Auxiliary Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskAuxiliaryTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/AuxiliaryTasks/Batch": { "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Create a new collection of Regular Asset Type Task Auxiliary 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| regularAssetTypeTaskId | RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| auxiliaryTaskId | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAuxiliaryTask->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| auxiliaryTaskId | Required | True | |\r\n| auxiliaryTaskId | Nullable | False | |\r\n| auxiliaryTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| auxiliaryType | Required | True | |\r\n| auxiliaryType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskAuxiliaryTask", "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/BatchCreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Auxiliary 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": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Update a collection of existing Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| auxiliaryType | RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskAuxiliaryTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| auxiliaryType | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskAuxiliaryTask", "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/BatchUpdateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/AuxiliaryTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Auxiliary Task resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/AuxiliaryTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Auxiliary Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/AuxiliaryTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Auxiliary Task resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/AuxiliaryTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Auxiliary Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/AuxiliaryTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Auxiliary Task resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/AuxiliaryTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskAuxiliaryTask->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": "ChangeRegularAssetTypeTaskAuxiliaryTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAuxiliaryTaskIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/AuxiliaryTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskAuxiliaryTask->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": "ChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/AuxiliaryTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Auxiliary Task resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Auxiliary 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/RegularAssetTypeTasks/AuxiliaryTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskAuxiliaryTask->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| 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": "BatchChangeRegularAssetTypeTaskAuxiliaryTaskIsActive", "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/BatchChangeRegularAssetTypeTaskAuxiliaryTaskIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/AuxiliaryTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Auxiliary Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Task Auxiliary 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 | RegularAssetTypeTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskAuxiliaryTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTree", "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/BatchChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Conditions/{id}": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Get a Regular Asset Type Task 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| createdByUserId | RegularAssetTypeTaskCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskCondition->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskCondition->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskCondition->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskCondition->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskIntervalType1Id | RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeTaskCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetTypeTaskCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTypeTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeTaskCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskCondition->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTypeTaskCondition->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTypeTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTypeTaskCondition->Interval_Description | string | |\r\n| notes | RegularAssetTypeTaskCondition->Notes | string | |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetRegularAssetTypeTaskCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Condition", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Update an existing Regular Asset Type Task 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 | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskCondition->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskConditionResourceActionRequest" } }, { "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 - Regular Asset Type Task 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" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Get a collection of Regular Asset Type Task 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 | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskIntervalType1Id | RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id | integer | int64 |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeTaskCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetTypeTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeTaskCondition->Condition_ConditionType_Description | string | |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTypeTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTypeTaskCondition->Interval_Description | string | |\r\n| isActive | RegularAssetTypeTaskCondition->IsActive | boolean | |\r\n| isInherited | RegularAssetTypeTaskCondition->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | RegularAssetTypeTaskCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetRegularAssetTypeTaskConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Create a new Regular Asset Type Task 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| regularAssetTypeTaskId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id | integer | int64 |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskCondition->PermissionTree_Id | integer | int64 |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskCondition->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskCondition->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| conditionId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| state | System Generated | true | If no value specified |\r\n| adjustmentFactor | System Generated | true | If no value specified |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskCondition", "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/CreateRegularAssetTypeTaskConditionResourceActionRequest" } }, { "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/RegularAssetTypeTasks/{id}/Conditions": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Get a collection of Regular Asset Type Task Condition for the Regular Asset Type 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 | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeTaskCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetTypeTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeTaskCondition->Condition_ConditionType_Description | string | |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| isInherited | RegularAssetTypeTaskCondition->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | RegularAssetTypeTaskCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n", "operationId": "GetRegularAssetTypeTaskConditionForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskConditionForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/{parentNodeType}/{parentId}/Recursive": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Get a collection of Regular Asset Type Task 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| regularAssetTypeTaskId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskAssetTypeTreePathItems | RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_TreePathItems | array | array |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentCode | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Code | string | |\r\n| regularAssetTypeTaskComponentDescription | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Description | string | |\r\n| regularAssetTypeTaskComponentTreePathItems | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_TreePathItems | array | array |\r\n| regularAssetTypeTaskVersion | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Version | integer | int32 |\r\n| regularAssetTypeTaskPermissionTreeId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_PermissionTree_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskIntervalType1Id | RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id | integer | int64 |\r\n| regularAssetTypeTaskIntervalType1Code | RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Code | string | |\r\n| regularAssetTypeTaskIntervalType2Code | RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType2_Code | string | |\r\n| regularAssetTypeTaskAllowConditions | RegularAssetTypeTaskCondition->RegularAssetTypeTask_AllowConditions | boolean | |\r\n| regularAssetTypeTaskMotionType | RegularAssetTypeTaskCondition->RegularAssetTypeTask_MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| id | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeTaskCondition->Condition_Description | string | |\r\n", "operationId": "GetRegularAssetTypeTaskConditionsRecursiveForParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[AssetTypes, AssetTypeFolders, RegularAssetTypes, InPlaceAssetTypes, PlaceholderAssetTypes, AssetTypeComponents, RegularAssetTypeComponents, PlaceholderAssetTypeComponents, AssetTypeTasks, AssetTaskResources, AssetTypeTaskResources, AssetTypeTaskSpares, RegularAssetTypeTasks, AuxiliaryAssetTypeTasks, RegularAssetTypeTaskFollowUpTasks, RegularAssetTypeTaskSuppressedTasks, RegularAssetTypeTaskAuxiliaryTasks, RegularAssetTypeTaskSpares, RegularAssetTypeTaskSpareRuleLinks, RegularAssetTypeTaskResourceRuleLinks, RegularAssetTypeTaskConditions, Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents, AssetTasks, AssetTaskSpares, RegularAssetTasks, AuxiliaryAssetTasks, RegularAssetTaskFollowUpTasks, RegularAssetTaskSuppressedTasks, RegularAssetTaskAuxiliaryTasks, RegularAssetTaskSpares, RegularAssetTaskConditions, Sites, PermissionTrees, WorkOrders]", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskConditionsRecursiveForParentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Lookups/LookupRegularAssetTypeTaskConditionAllTaskInterval": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Lookup the Task Interval for the Regular Asset Type Task 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 | TaskInterval->Id | integer | int64 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskConditionAllTaskInterval", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskConditionAllTaskIntervalLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Lookups/LookupRegularAssetTypeTaskConditionChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Lookup the permission set for changing the Regular Asset Type Task 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": "LookupRegularAssetTypeTaskConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Lookups/LookupRegularAssetTypeTaskConditionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Lookup the permission set for creating the Regular Asset Type Task 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": "LookupRegularAssetTypeTaskConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Lookups/LookupRegularAssetTypeTaskConditionRegularAssetTypeCondition": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Lookup the Regular Asset Type Condition for the Regular Asset Type Task 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 | Condition->Id | integer | int64 |\r\n| code | Condition->Code | string | |\r\n| description | Condition->Description | string | |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskConditionRegularAssetTypeCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskConditionRegularAssetTypeConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Lookups/LookupRegularAssetTypeTaskConditionRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Lookup the Regular Asset Type Task for the Regular Asset Type Task 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTypeTask->IntervalType1_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskConditionRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskConditionRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Lookups/LookupRegularAssetTypeTaskConditionTaskInterval": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Lookup the Task Interval for the Regular Asset Type Task 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 | TaskInterval->Id | integer | int64 |\r\n| code | TaskInterval->Code | string | |\r\n| description | TaskInterval->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskConditionTaskInterval", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskConditionTaskIntervalLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Get a collection of Regular Asset Type Task 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| createdByUserId | RegularAssetTypeTaskCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskCondition->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskCondition->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskCondition->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskCondition->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskCondition->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskCondition->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskCondition->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskIntervalType1Id | RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTypeTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTypeTaskCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetTypeTaskCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTypeTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTypeTaskCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskCondition->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTypeTaskCondition->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTypeTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTypeTaskCondition->Interval_Description | string | |\r\n| notes | RegularAssetTypeTaskCondition->Notes | string | |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetRegularAssetTypeTaskCondition", "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 Regular Asset Type Task 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 Regular Asset Type Task Condition collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/Batch": { "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Create a new collection of Regular Asset Type Task 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| regularAssetTypeTaskId | RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id | integer | int64 |\r\n| conditionId | RegularAssetTypeTaskCondition->Condition_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskCondition->PermissionTree_Id | integer | int64 |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskCondition->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskCondition->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| conditionId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| state | System Generated | true | If no value specified |\r\n| adjustmentFactor | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskCondition", "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/BatchCreateRegularAssetTypeTaskConditionResourceActionRequest" } }, { "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 - Regular Asset Type Task 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": [ "Regular Asset Type Task Condition" ], "summary": "Update a collection of existing Regular Asset Type Task 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 | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskCondition->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskCondition", "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/BatchUpdateRegularAssetTypeTaskConditionResourceActionRequest" } }, { "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 - Regular Asset Type Task 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" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Condition resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Condition 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/RegularAssetTypeTasks/Conditions/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Condition resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Condition 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/RegularAssetTypeTasks/Conditions/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Condition resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Condition 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/RegularAssetTypeTasks/Conditions/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Condition resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Condition 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/RegularAssetTypeTasks/Conditions/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Condition resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Condition 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/RegularAssetTypeTasks/Conditions/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task 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 | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskCondition->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": "ChangeRegularAssetTypeTaskConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskConditionIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Task 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 | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskCondition->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": "ChangeRegularAssetTypeTaskConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Condition resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Condition 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/RegularAssetTypeTasks/Conditions/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task 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 | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskCondition->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| 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": "BatchChangeRegularAssetTypeTaskConditionIsActive", "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/BatchChangeRegularAssetTypeTaskConditionIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Task 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 | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskCondition->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskConditionPermissionTree", "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/BatchChangeRegularAssetTypeTaskConditionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Conditions/MatchBatch": { "patch": { "tags": [ "Regular Asset Type Task Condition" ], "summary": "Update a collection of existing Regular Asset Type Task Condition resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskCondition->Version | integer | int32 |\r\n| state | RegularAssetTypeTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTypeTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTypeTaskCondition->Interval_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskCondition->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskCondition->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 | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\r\n\r\n", "operationId": "MatchUpdateRegularAssetTypeTaskCondition", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateRegularAssetTypeTaskConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type Task 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" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents/{id}": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Get a Regular Asset Type Task Document resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Description | string | |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| inheritedFrom | RegularAssetTypeTaskDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskDocument | RegularAssetTypeTaskDocument->InheritedFromStandardTaskDocument | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeTaskDocument->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | RegularAssetTypeTaskDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTypeTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTypeTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTypeTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTypeTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTypeTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTypeTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeTaskDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Document", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Update an existing Regular Asset Type Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskDocument->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| copyDocumentLink | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Task Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Delete an existing Regular Asset Type Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskDocument->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": "DeleteRegularAssetTypeTaskDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTypeTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type Task Document was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/{regularAssetTypeTaskId}/Documents": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Get a collection of Regular Asset Type Task Document resources for the Regular Asset Type 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 | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskDocument->IsInherited | boolean | |\r\n| documentRecordId | RegularAssetTypeTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTypeTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTypeTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTypeTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeTaskDocument->Notes | string | |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| createdOn | RegularAssetTypeTaskDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeTaskDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeTaskDocumentCollectionForRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeTaskId", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskDocumentCollectionForRegularAssetTypeTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Get a collection of Regular Asset Type Task Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskDocument->IsInherited | boolean | |\r\n| documentRecordId | RegularAssetTypeTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTypeTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTypeTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTypeTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| notes | RegularAssetTypeTaskDocument->Notes | string | |\r\n| createdOn | RegularAssetTypeTaskDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeTaskDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeTaskDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Create a new Regular Asset Type Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Id | integer | int64 |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | RegularAssetTypeTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskDocument->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| copyDocumentLink | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskDocument", "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/CreateRegularAssetTypeTaskDocumentResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Documents/Lookups/LookupRegularAssetTypeTaskDocumentChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Lookup the permission set for changing the Regular Asset Type Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents/Lookups/LookupRegularAssetTypeTaskDocument": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Lookup the Document Record for the Regular Asset Type Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents/Lookups/LookupRegularAssetTypeTaskDocumentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Lookup the permission set for creating the Regular Asset Type Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents/Lookups/LookupRegularAssetTypeTaskDocumentRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Lookup the Regular Asset Type Task Document for the Regular Asset Type Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskDocumentRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskDocumentRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Get a collection of Regular Asset Type Task Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Description | string | |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| inheritedFrom | RegularAssetTypeTaskDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskDocument | RegularAssetTypeTaskDocument->InheritedFromStandardTaskDocument | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | RegularAssetTypeTaskDocument->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | RegularAssetTypeTaskDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTypeTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTypeTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTypeTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTypeTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTypeTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTypeTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTypeTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTypeTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTypeTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTypeTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTypeTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTypeTaskDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetTypeTaskDocument", "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 Regular Asset Type Task Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Document collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents/Batch": { "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Create a new collection of Regular Asset Type Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskDocument->RegularAssetTypeTask_Id | integer | int64 |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | RegularAssetTypeTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskDocument->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| copyDocumentLink | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskDocument", "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/BatchCreateRegularAssetTypeTaskDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Task Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Update a collection of existing Regular Asset Type Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| copyDocumentLink | RegularAssetTypeTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| id | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskDocument->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| copyDocumentLink | Nullable | False | |\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\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskDocument", "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/BatchUpdateRegularAssetTypeTaskDocumentResourceActionRequest" } }, { "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 - Regular Asset Type Task Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Delete a collection of existing Regular Asset Type Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskDocument->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetTypeTaskDocument", "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/BatchDeleteRegularAssetTypeTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type Task Document batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Document resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document 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/RegularAssetTypeTasks/Documents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Document resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Document 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/RegularAssetTypeTasks/Documents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Document resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Document 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/RegularAssetTypeTasks/Documents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Document resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Document 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/RegularAssetTypeTasks/Documents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Document resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document 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/RegularAssetTypeTasks/Documents/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskDocument->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": "ChangeRegularAssetTypeTaskDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskDocumentIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskDocument->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": "ChangeRegularAssetTypeTaskDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Document resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Document 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/RegularAssetTypeTasks/Documents/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskDocument->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": "BatchChangeRegularAssetTypeTaskDocumentIsActive", "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/BatchChangeRegularAssetTypeTaskDocumentIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Document" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskDocument->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| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskDocumentPermissionTree", "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/BatchChangeRegularAssetTypeTaskDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/FollowUpTasks/{id}": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Get a Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskFollowUpTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskFollowUpTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskFollowUpTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskFollowUpTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskFollowUpTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskFollowUpTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskFollowUpTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskFollowUpTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskFollowUpTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskFollowUpTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskFollowUpTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskFollowUpTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskFollowUpTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskFollowUpTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskMonitoringPointTypeId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_Id | integer | int64 |\r\n| regularAssetTypeTaskMonitoringPointTypeHasUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| regularAssetTypeTaskMonitoringPointTypeHasUpperWarningBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| regularAssetTypeTaskMonitoringPointTypeHasLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| regularAssetTypeTaskMonitoringPointTypeHasLowerWarningBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasLowerWarningBound | boolean | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| addToWorkOrder | RegularAssetTypeTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskFollowUpTask->Notes | string | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n", "operationId": "GetRegularAssetTypeTaskFollowUpTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Follow Up Task", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Update an existing Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| addToWorkOrder | RegularAssetTypeTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| triggerWhenLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTask->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| followUpTaskId | Nullable | False | |\r\n| followUpTaskId | Min Value | > 0| |\r\n| addToWorkOrder | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskFollowUpTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskFollowUpTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/{regularAssetTypeTaskId}/FollowUpTasks": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Get a collection of Regular Asset Type Task Follow Up Task resources for the Regular Asset Type 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 | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskFollowUpTask->Notes | string | |\r\n| isInherited | RegularAssetTypeTaskFollowUpTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTypeTaskFollowUpTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| createdOn | RegularAssetTypeTaskFollowUpTask->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeTaskFollowUpTask->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeTaskFollowUpTaskForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeTaskId", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Follow Up Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Get a collection of Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskFollowUpTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description | string | |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| notes | RegularAssetTypeTaskFollowUpTask->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskFollowUpTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Follow Up Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Create a new Regular Asset Type Task Follow Up 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| regularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| addToWorkOrder | RegularAssetTypeTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTask->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| followUpTaskId | Required | True | |\r\n| followUpTaskId | Nullable | False | |\r\n| followUpTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| addToWorkOrder | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskFollowUpTask", "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/CreateRegularAssetTypeTaskFollowUpTaskResourceActionRequest" } }, { "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/RegularAssetTypeTasks/FollowUpTasks/Lookups/LookupRegularAssetTypeTaskFollowUpTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Lookup the permission set for changing the Regular Asset Type Task Follow Up 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": "LookupRegularAssetTypeTaskFollowUpTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Lookups/LookupRegularAssetTypeTaskFollowUpTaskFollowUpTask": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Lookup the Regular Asset Type Task Follow Up Task for the Regular Asset Type Task Follow Up 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskFollowUpTaskFollowUpTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskFollowUpTaskFollowUpTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Lookups/LookupRegularAssetTypeTaskFollowUpTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Lookup the permission set for creating the Regular Asset Type Task Follow Up 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": "LookupRegularAssetTypeTaskFollowUpTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Lookups/LookupRegularAssetTypeTaskFollowUpTaskRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Lookup the Regular Asset Type Task Follow Up Task for the Regular Asset Type Task Follow Up 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| monitoringPointTypeId | RegularAssetTypeTask->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeHasUpperCriticalBound | RegularAssetTypeTask->MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| monitoringPointTypeHasUpperWarningBound | RegularAssetTypeTask->MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| monitoringPointTypeHasLowerCriticalBound | RegularAssetTypeTask->MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| monitoringPointTypeHasLowerWarningBound | RegularAssetTypeTask->MonitoringPointType_HasLowerWarningBound | boolean | |\r\n", "operationId": "LookupRegularAssetTypeTaskFollowUpTaskRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Get a collection of Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskFollowUpTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskFollowUpTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskFollowUpTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskFollowUpTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskFollowUpTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskFollowUpTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskFollowUpTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskFollowUpTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskFollowUpTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskFollowUpTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskFollowUpTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskFollowUpTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskFollowUpTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskFollowUpTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskMonitoringPointTypeId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_Id | integer | int64 |\r\n| regularAssetTypeTaskMonitoringPointTypeHasUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| regularAssetTypeTaskMonitoringPointTypeHasUpperWarningBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| regularAssetTypeTaskMonitoringPointTypeHasLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| regularAssetTypeTaskMonitoringPointTypeHasLowerWarningBound | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasLowerWarningBound | boolean | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| addToWorkOrder | RegularAssetTypeTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskFollowUpTask->Notes | string | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n", "operationId": "BatchGetRegularAssetTypeTaskFollowUpTask", "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 Regular Asset Type Task Follow Up 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 Regular Asset Type Task Follow Up Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskFollowUpTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Batch": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Create a new collection of Regular Asset Type Task Follow Up 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| regularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| triggerWhenLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTask->Notes | string | |\r\n| addToWorkOrder | RegularAssetTypeTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| followUpTaskId | Required | True | |\r\n| followUpTaskId | Nullable | False | |\r\n| followUpTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| addToWorkOrder | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskFollowUpTask", "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/BatchCreateRegularAssetTypeTaskFollowUpTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Follow Up 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": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Update a collection of existing Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| followUpTaskId | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| addToWorkOrder | RegularAssetTypeTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| triggerWhenLowerCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| followUpTaskId | Nullable | False | |\r\n| followUpTaskId | Min Value | > 0| |\r\n| addToWorkOrder | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskFollowUpTask", "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/BatchUpdateRegularAssetTypeTaskFollowUpTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/FollowUpTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Follow Up Task resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/FollowUpTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Follow Up Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/FollowUpTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Follow Up Task resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/FollowUpTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Follow Up Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/FollowUpTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Follow Up Task resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/FollowUpTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskFollowUpTask->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": "ChangeRegularAssetTypeTaskFollowUpTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/FollowUpTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTask->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": "ChangeRegularAssetTypeTaskFollowUpTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/FollowUpTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Follow Up Task resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up 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/RegularAssetTypeTasks/FollowUpTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskFollowUpTask->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| 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": "BatchChangeRegularAssetTypeTaskFollowUpTaskIsActive", "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/BatchChangeRegularAssetTypeTaskFollowUpTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/FollowUpTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskFollowUpTaskPermissionTree", "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/BatchChangeRegularAssetTypeTaskFollowUpTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{id}": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Get a Regular Asset Type Task Follow Up Task Expression resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskFollowUpTaskExpression->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskFollowUpTaskExpression->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskFollowUpTaskExpression->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskFollowUpTaskExpression->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| createdByUserId | RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskFollowUpTaskExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTaskExpression->InheritedFrom_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| monitoringPointTriggerExpressionId | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->Notes | string | |\r\n| regularAssetTypeTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskDescription | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Description | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskInspectionType | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n", "operationId": "GetRegularAssetTypeTaskFollowUpTaskExpression", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Follow Up Task Expression", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskExpressionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Update an existing Regular Asset Type Task Follow Up Task Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->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| manualReadingRequired | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskFollowUpTaskExpression", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest" } }, { "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 - Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Get a collection of Regular Asset Type Task Follow Up Task Expression resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| inheritedFromRegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->InheritedFrom_RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code | string | |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskInspectionType | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| monitoringPointTriggerExpressionId | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskFollowUpTaskExpressionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Follow Up Task Expression collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskExpressionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Create a new Regular Asset Type Task Follow Up Task Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionId | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->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| regularAssetTypeTaskFollowUpTaskId | Required | True | |\r\n| regularAssetTypeTaskFollowUpTaskId | Nullable | False | |\r\n| regularAssetTypeTaskFollowUpTaskId | Min Value | > 0| |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| monitoringPointTriggerExpressionId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| manualReadingRequired | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskFollowUpTaskExpression", "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/CreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest" } }, { "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/RegularAssetTypeTasks/FollowUpTasks/{regularAssetTypeTaskFollowUpTaskId}/Expressions": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Get a collection of Regular Asset Type Task Follow Up Task Expression resources for the Regular Asset Type Task Follow Up 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 | RegularAssetTypeTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->Notes | string | |\r\n| isInherited | RegularAssetTypeTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTaskExpression->InheritedFrom_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| regularAssetTypeTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskDescription | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Description | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Description | string | |\r\n| monitoringPointTriggerExpressionId | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| createdOn | RegularAssetTypeTaskFollowUpTaskExpression->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTypeTaskFollowUpTaskExpressionForRegularAssetTypeTaskFollowUpTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeTaskFollowUpTaskId", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up 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 Regular Asset Type Task Follow Up Task Expression collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskExpressionForRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Expressions/Lookups/LookupRegularAssetTypeTaskFollowUpTaskExpressionChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Lookup the permission set for changing the Regular Asset Type Task Follow Up Task Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskFollowUpTaskExpressionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Expressions/Lookups/LookupRegularAssetTypeTaskFollowUpTaskExpressionFollowUpTask": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Lookup the Regular Asset Type Task Follow Up Task Expression for the Regular Asset Type Task Follow Up Task Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskFollowUpTask->Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskInspectionType | RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n", "operationId": "LookupRegularAssetTypeTaskFollowUpTaskExpressionFollowUpTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Follow Up Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskFollowUpTaskExpressionFollowUpTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Expressions/Lookups/LookupRegularAssetTypeTaskFollowUpTaskExpressionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Lookup the permission set for creating the Regular Asset Type Task Follow Up Task Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTypeTaskFollowUpTaskExpressionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Expressions/Lookups/LookupRegularAssetTypeTaskFollowUpTaskExpressionMPTExpression": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Lookup the Regular Asset Type Task Follow Up Task for the Regular Asset Type Task Follow Up Task Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskFollowUpTaskExpressionMPTExpression", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Monitoring Point Trigger Expression collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskFollowUpTaskMPTExpressionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Expressions/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Get a collection of Regular Asset Type Task Follow Up Task Expression resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| developmentStatus | RegularAssetTypeTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskFollowUpTaskExpression->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskFollowUpTaskExpression->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskFollowUpTaskExpression->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskFollowUpTaskExpression->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| createdByUserId | RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskFollowUpTaskExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskFollowUpTaskExpression->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskFollowUpTaskExpression->InheritedFrom_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| monitoringPointTriggerExpressionId | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->Notes | string | |\r\n| regularAssetTypeTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| regularAssetTypeTaskFollowUpTaskFollowUpTaskDescription | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Description | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskDescription | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskInspectionType | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n", "operationId": "BatchGetRegularAssetTypeTaskFollowUpTaskExpression", "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 Regular Asset Type Task Follow Up Task Expression 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 Regular Asset Type Task Follow Up Task Expression collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskFollowUpTaskExpressionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/FollowUpTasks/Expressions/Batch": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Create a new collection of Regular Asset Type Task Follow Up Task Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskFollowUpTaskId | RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionId | RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->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| regularAssetTypeTaskFollowUpTaskId | Required | True | |\r\n| regularAssetTypeTaskFollowUpTaskId | Nullable | False | |\r\n| regularAssetTypeTaskFollowUpTaskId | Min Value | > 0| |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| monitoringPointTriggerExpressionId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| manualReadingRequired | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskFollowUpTaskExpression", "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/BatchCreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest" } }, { "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 - Regular Asset Type Task Follow Up Task Expression 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": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Update a collection of existing Regular Asset Type Task Follow Up Task Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| manualReadingRequired | RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTypeTaskFollowUpTaskExpression->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| manualReadingRequired | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskFollowUpTaskExpression", "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/BatchUpdateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest" } }, { "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 - Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Follow Up Task Expression resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Follow Up Task Expression resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Follow Up Task Expression resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Follow Up Task Expression resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Follow Up Task Expression resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Follow Up Task Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskFollowUpTaskExpression->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": "ChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Task Follow Up Task Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTaskExpression->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": "ChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/FollowUpTasks/Expressions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Follow Up Task Expression resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Follow Up Task Expression 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/RegularAssetTypeTasks/FollowUpTasks/Expressions/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Follow Up Task Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskFollowUpTaskExpression->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": "BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActive", "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/BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/FollowUpTasks/Expressions/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Follow Up Task Expression" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Task Follow Up Task Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskFollowUpTaskExpression->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| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTree", "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/BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Resources/{id}": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Get a Regular Asset Type 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| rulesLastChangedOn | RegularAssetTypeTaskResource->RulesLastChangedOn | string | date-time |\r\n| createdByUserId | RegularAssetTypeTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskResource->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskResource->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskResource->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskResource->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskResource->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskResource->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskResource->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskResource->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskResource->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskResource->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTypeTaskResource->Competency_Description | string | |\r\n| competencyValidityType | RegularAssetTypeTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskResource->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskRecordType | RegularAssetTypeTaskResource->InheritedFrom_RegularAssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| isHistorical | RegularAssetTypeTaskResource->IsHistorical | boolean | |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| recordType | RegularAssetTypeTaskResource->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceDescription | RegularAssetTypeTaskResource->Resource_Description | string | |\r\n| resourceContactDetailId | RegularAssetTypeTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | RegularAssetTypeTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetTypeTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetTypeTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | RegularAssetTypeTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n", "operationId": "GetRegularAssetTypeTaskResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Resource", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Update an existing Regular Asset Type 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 | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskResource->RegularAssetTypeTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | RegularAssetTypeTaskResource->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| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| tradeId | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskResourceResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks/Resources": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Get a collection of Regular Asset Type Task Resource resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskResource->IsActive | boolean | |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskResource->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskResource->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskResource->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeTreePathItems | RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_TreePathItems | array | array |\r\n| regularAssetTypeTaskComponentTreePathItems | RegularAssetTypeTaskResource->RegularAssetTypeTask_Component_TreePathItems | array | array |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeTaskResource->Trade_Description | string | |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceDescription | RegularAssetTypeTaskResource->Resource_Description | string | |\r\n| resourceContactDetailFirstName | RegularAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTypeTaskResource->Competency_Description | string | |\r\n| rulesLastChangedOn | RegularAssetTypeTaskResource->RulesLastChangedOn | string | date-time |\r\n| inheritedFromId | RegularAssetTypeTaskResource->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetTypeTaskResource->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeTaskResourceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Resource collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Create a new Regular Asset Type 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| regularAssetTypeTaskId | RegularAssetTypeTaskResource->RegularAssetTypeTask_Id | integer | int64 |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n| permissionTreeId | RegularAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | RegularAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetTypeTaskResource->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| usage | System Generated | true | If no value specified |\r\n| usage | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\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": "CreateRegularAssetTypeTaskResource", "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/CreateRegularAssetTypeTaskResourceResourceActionRequest" } }, { "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/RegularAssetTypeTasks/{regularAssetTypeTaskId}/Resources": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Get a collection of Regular Asset Type Task Resource resources for the Regular Asset Type 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 | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeTaskResource->Trade_Description | string | |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | RegularAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTypeTaskResource->Competency_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskResource->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetTypeTaskResource->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeTaskResourceForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeTaskId", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Resource collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the permission set for changing the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceCompetency": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the Competency for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceCompetency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceCompetencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceFilterByTrade": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the Trade for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceFilterByTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceFilterByTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceFilterByTradeUnitOfMeasurement": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceFilterByTradeUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the permission set for creating the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the Regular Asset Type Task Resource for the Regular Asset Type 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskResourceRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskResourceRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceResource": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the Resource for the Regular Asset Type 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| description | Resource->Description | string | |\r\n| resourceType | Resource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskResourceResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceSection": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the Section for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceTrade": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the Trade for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Lookups/LookupRegularAssetTypeTaskResourceUnitOfMeasurement": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Lookup the for the Regular Asset Type 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": "LookupRegularAssetTypeTaskResourceUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Get a collection of Regular Asset Type 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| rulesLastChangedOn | RegularAssetTypeTaskResource->RulesLastChangedOn | string | date-time |\r\n| createdByUserId | RegularAssetTypeTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskResource->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskResource->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskResource->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskResource->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskResource->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskResource->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskResource->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskResource->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskResource->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskResource->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskResource->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTypeTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTypeTaskResource->Competency_Description | string | |\r\n| competencyValidityType | RegularAssetTypeTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskResource->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskRecordType | RegularAssetTypeTaskResource->InheritedFrom_RegularAssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| isHistorical | RegularAssetTypeTaskResource->IsHistorical | boolean | |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| recordType | RegularAssetTypeTaskResource->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeTaskResource->Resource_Code | string | |\r\n| resourceDescription | RegularAssetTypeTaskResource->Resource_Description | string | |\r\n| resourceContactDetailId | RegularAssetTypeTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetTypeTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTypeTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTypeTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTypeTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTypeTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTypeTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | RegularAssetTypeTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetTypeTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetTypeTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | RegularAssetTypeTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n", "operationId": "BatchGetRegularAssetTypeTaskResource", "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 Regular Asset Type 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 Regular Asset Type Task Resource collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/Batch": { "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Create a new collection of Regular Asset Type 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| regularAssetTypeTaskId | RegularAssetTypeTaskResource->RegularAssetTypeTask_Id | integer | int64 |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n| permissionTreeId | RegularAssetTypeTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | RegularAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetTypeTaskResource->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| usage | System Generated | true | If no value specified |\r\n| usage | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\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": "BatchCreateRegularAssetTypeTaskResource", "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/BatchCreateRegularAssetTypeTaskResourceResourceActionRequest" } }, { "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 - Regular Asset Type 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": [ "Regular Asset Type Task Resource" ], "summary": "Update a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskResource->RegularAssetTypeTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskResource->Notes | string | |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | integer | int32 |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | RegularAssetTypeTaskResource->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| tradeId | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskResource", "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/BatchUpdateRegularAssetTypeTaskResourceResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks/Resources/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Resource resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/Resources/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Resource resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/Resources/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Resource resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/Resources/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Resource resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/Resources/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Resource resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/Resources/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Change the IsActive status for an existing Regular Asset Type 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 | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskResource->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": "ChangeRegularAssetTypeTaskResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskResourceIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/Resources/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Change the PermissionTree for an existing Regular Asset Type 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 | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskResource->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": "ChangeRegularAssetTypeTaskResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskResourcePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Resources/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Resource resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/Resources/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskResource->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": "BatchChangeRegularAssetTypeTaskResourceIsActive", "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/BatchChangeRegularAssetTypeTaskResourceIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/Resources/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskResource->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| id | Min Value | > 0| |\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": "BatchChangeRegularAssetTypeTaskResourcePermissionTree", "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/BatchChangeRegularAssetTypeTaskResourcePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Resources/MatchBatch": { "patch": { "tags": [ "Regular Asset Type Task Resource" ], "summary": "Update a collection of existing Regular Asset Type Task Resource resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResource->Version | integer | int32 |\r\n| quantity | RegularAssetTypeTaskResource->Quantity | integer | int32 |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | RegularAssetTypeTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTypeTaskResource->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTypeTaskResource->Trade_Id | integer | int64 |\r\n| competencyId | RegularAssetTypeTaskResource->Competency_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetTypeTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| usage | RegularAssetTypeTaskResource->Usage | object | composite |\r\n| sequenceNumber | RegularAssetTypeTaskResource->SequenceNumber | integer | int32 |\r\n| proficiency | RegularAssetTypeTaskResource->Proficiency | 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 | Min Value | > 0| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| tradeId | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| usage | Nullable | False | |\r\n| usage | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateRegularAssetTypeTaskResource", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateRegularAssetTypeTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type 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/RegularAssetTypeTasks/Resources/RuleLinks/{id}": { "get": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Get a Regular Asset Type Task Resource Rule Link 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| developmentStatus | RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskResourceRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskResourceRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskResourceRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskResourceRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskResourceRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskResourceRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| ruleId | RegularAssetTypeTaskResourceRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskResourceRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskResourceRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeTaskResourceRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->SequenceNumber | integer | int32 |\r\n| createdByUserId | RegularAssetTypeTaskResourceRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskResourceRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskResourceRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskResourceRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskResourceRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| inheritedFromRuleId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeTaskResourceRuleLink->Notes | string | |\r\n| regularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskResourceResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceResourceCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code | string | |\r\n| regularAssetTypeTaskResourceResourceDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Description | string | |\r\n", "operationId": "GetRegularAssetTypeTaskResourceRuleLink", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Rule Link Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Resource Rule Link", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceRuleLinkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Update an existing Regular Asset Type Task Resource Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskResourceRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskResourceRuleLink", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks": { "get": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Resource Rule Link 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 | RegularAssetTypeTaskResourceRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| regularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskResourceResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceResourceCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code | string | |\r\n| regularAssetTypeTaskResourceResourceDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Description | string | |\r\n| ruleId | RegularAssetTypeTaskResourceRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskResourceRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskResourceRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description | string | |\r\n| isActive | RegularAssetTypeTaskResourceRuleLink->IsActive | boolean | |\r\n| isInherited | RegularAssetTypeTaskResourceRuleLink->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskResourceRuleLinkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Resource Rule Link collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceRuleLinkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Create a new Regular Asset Type Task Resource Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskResourceRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskResourceRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->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| regularAssetTypeTaskResourceId | Required | True | |\r\n| regularAssetTypeTaskResourceId | Nullable | False | |\r\n| regularAssetTypeTaskResourceId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskResourceRuleLink", "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/CreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Resources/{id}/RuleLinks": { "get": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Resource Rule Link resources for the Regular Asset Type 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 | RegularAssetTypeTaskResourceRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| regularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskResourceResourceCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code | string | |\r\n| ruleId | RegularAssetTypeTaskResourceRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskResourceRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskResourceRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskResourceRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTypeTaskResourceRuleLinkForRegularAssetTypeTaskResourceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Resource Rule Link collection", "schema": { "$ref": "#/definitions/GetRuleLinkForRegularAssetTypeTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/RuleLinks/Lookups/LookupRegularAssetTypeTaskResourceRuleLinkRegularAssetTypeTaskResource": { "get": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Lookup the Regular Asset Type Task Resource Rule Link for the Regular Asset Type Task Resource Rule Link.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskResource->Id | integer | int64 |\r\n| resourceId | RegularAssetTypeTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTypeTaskResource->Resource_Code | string | |\r\n| tradeCode | RegularAssetTypeTaskResource->Trade_Code | string | |\r\n| sectionCode | RegularAssetTypeTaskResource->Section_Code | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskResource->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskResource->RegularAssetTypeTask_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskResourceRuleLinkRegularAssetTypeTaskResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Resource collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskResourceRuleLinkTaskRegularAssetTypeTaskResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/RuleLinks/Lookups/LookupRegularAssetTypeTaskResourceRuleLinkRule": { "get": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Lookup the Rule for the Regular Asset Type Task Resource Rule Link.", "description": "### Response Body\r\n#### Payload\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| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskResourceRuleLinkRule", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskResourceRuleLinkRuleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/RuleLinks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Resource Rule Link 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| developmentStatus | RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskResourceRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskResourceRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskResourceRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskResourceRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskResourceRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskResourceRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| ruleId | RegularAssetTypeTaskResourceRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskResourceRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskResourceRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeTaskResourceRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->SequenceNumber | integer | int32 |\r\n| createdByUserId | RegularAssetTypeTaskResourceRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskResourceRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskResourceRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskResourceRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskResourceRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| inheritedFromRuleId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeTaskResourceRuleLink->Notes | string | |\r\n| regularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskResourceResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Id | integer | int64 |\r\n| regularAssetTypeTaskResourceResourceCode | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code | string | |\r\n| regularAssetTypeTaskResourceResourceDescription | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTypeTaskResourceRuleLink", "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 Regular Asset Type Task Resource Rule Link 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 Regular Asset Type Task Resource Rule Link collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskResourceRuleLinkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Resources/RuleLinks/Batch": { "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Create a new collection of Regular Asset Type Task Resource Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskResourceId | RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskResourceRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskResourceRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->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| regularAssetTypeTaskResourceId | Required | True | |\r\n| regularAssetTypeTaskResourceId | Nullable | False | |\r\n| regularAssetTypeTaskResourceId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskResourceRuleLink", "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/BatchCreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Resource Rule Link 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": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Update a collection of existing Regular Asset Type Task Resource Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskResourceRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskResourceRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskResourceRuleLink->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskResourceRuleLink", "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/BatchUpdateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Regular Asset Type Task Resource Rule Link", "description": "", "operationId": "AcceptRegularAssetTypeTaskResourceRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Resource Rule Link resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskResourceRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Resource Rule Link resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskResourceRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Resource Rule Link resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskResourceRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Resource Rule Link resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskResourceRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Resource Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskResourceRuleLink->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": "ChangeRegularAssetTypeTaskResourceRuleLinkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskResourceRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Resources/RuleLinks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Regular Asset Type Task Resource Rule Link", "description": "", "operationId": "RejectRegularAssetTypeTaskResourceRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Resource Rule Link 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/RegularAssetTypeTasks/Resources/RuleLinks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Resource Rule Link" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Resource Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskResourceRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskResourceRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskResourceRuleLink->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| 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": "BatchChangeRegularAssetTypeTaskResourceRuleLinkIsActive", "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/BatchChangeRegularAssetTypeTaskResourceRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/RuleLinks/{id}": { "get": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Get a Regular Asset Type Task Rule Link 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| ruleId | RegularAssetTypeTaskRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeTaskRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | RegularAssetTypeTaskRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Code | string | |\r\n| regularAssetTypeTaskComponentDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeTaskRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Description | string | |\r\n| inheritedFromRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Description | string | |\r\n| inheritedFromRuleId | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeTaskRuleLink->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeTaskRuleLink", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Rule Link Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Rule Link", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskRuleLinkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Update an existing Regular Asset Type Task Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskRuleLink", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks": { "get": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Rule Link 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 | RegularAssetTypeTaskRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Code | string | |\r\n| regularAssetTypeTaskComponentDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Description | string | |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Description | string | |\r\n| ruleId | RegularAssetTypeTaskRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Description | string | |\r\n| isActive | RegularAssetTypeTaskRuleLink->IsActive | boolean | |\r\n| isInherited | RegularAssetTypeTaskRuleLink->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskRuleLinkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Rule Link collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskRuleLinkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Create a new Regular Asset Type Task Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskRuleLink", "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/CreateRegularAssetTypeTaskRuleLinkResourceActionRequest" } }, { "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/RegularAssetTypeTasks/{id}/RuleLinks": { "get": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Rule Link resources for the Regular Asset Type 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 | RegularAssetTypeTaskRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| ruleId | RegularAssetTypeTaskRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskRuleLink->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTypeTaskRuleLinkForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Rule Link collection", "schema": { "$ref": "#/definitions/GetRuleLinkForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/RuleLinks/Lookups/LookupRegularAssetTypeTaskRuleLinkRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Lookup the Regular Asset Type Task Rule Link for the Regular Asset Type Task Rule Link.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n| assetTypeId | RegularAssetTypeTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTypeTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTypeTask->AssetType_Description | string | |\r\n| componentId | RegularAssetTypeTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTypeTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTypeTask->Component_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskRuleLinkRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskRuleLinkTaskRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/RuleLinks/Lookups/LookupRegularAssetTypeTaskRuleLinkRule": { "get": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Lookup the Rule for the Regular Asset Type Task Rule Link.", "description": "### Response Body\r\n#### Payload\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| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskRuleLinkRule", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskRuleLinkRuleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/RuleLinks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Rule Link 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| ruleId | RegularAssetTypeTaskRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeTaskRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Description | string | |\r\n| createdByUserId | RegularAssetTypeTaskRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| developmentStatus | RegularAssetTypeTaskRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskComponentId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Id | integer | int64 |\r\n| regularAssetTypeTaskComponentCode | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Code | string | |\r\n| regularAssetTypeTaskComponentDescription | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->SequenceNumber | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeTaskRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Description | string | |\r\n| inheritedFromRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Description | string | |\r\n| inheritedFromRuleId | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeTaskRuleLink->Notes | string | |\r\n", "operationId": "BatchGetRegularAssetTypeTaskRuleLink", "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 Regular Asset Type Task Rule Link 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 Regular Asset Type Task Rule Link collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskRuleLinkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/RuleLinks/Batch": { "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Create a new collection of Regular Asset Type Task Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskRuleLink", "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/BatchCreateRegularAssetTypeTaskRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Rule Link 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": [ "Regular Asset Type Task Rule Link" ], "summary": "Update a collection of existing Regular Asset Type Task Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskRuleLink->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskRuleLink", "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/BatchUpdateRegularAssetTypeTaskRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Rule Link resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Rule Link resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Rule Link resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Rule Link resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Rule Link resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskRuleLink->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": "ChangeRegularAssetTypeTaskRuleLinkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/RuleLinks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Rule Link resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Rule Link 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/RegularAssetTypeTasks/RuleLinks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Rule Link" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskRuleLink->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| 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": "BatchChangeRegularAssetTypeTaskRuleLinkIsActive", "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/BatchChangeRegularAssetTypeTaskRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Spares/{id}": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Get a Regular Asset Type 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| rulesLastChangedOn | RegularAssetTypeTaskSpare->RulesLastChangedOn | string | date-time |\r\n| createdByUserId | RegularAssetTypeTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskSpare->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSpare->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSpare->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Code | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpare->SequenceNumber | integer | int32 |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTypeTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskSpare->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskRecordType | RegularAssetTypeTaskSpare->InheritedFrom_RegularAssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| isHistorical | RegularAssetTypeTaskSpare->IsHistorical | boolean | |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | RegularAssetTypeTaskSpare->Notes | string | |\r\n| preferredMaterialMasterId | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| preferredMaterialMasterCode | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Code | string | |\r\n| preferredMaterialMasterDescription | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Description | string | |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| recordType | RegularAssetTypeTaskSpare->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "GetRegularAssetTypeTaskSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Spare", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Update an existing Regular Asset Type 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 | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| preferredMaterialMasterId | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSpare->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": "UpdateRegularAssetTypeTaskSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSpareResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks/Spares": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTypeTaskSpare->CostElement_Description | string | |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeTreePathItems | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_TreePathItems | array | array |\r\n| regularAssetTypeTaskComponentTreePathItems | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Component_TreePathItems | array | array |\r\n| rulesLastChangedOn | RegularAssetTypeTaskSpare->RulesLastChangedOn | string | date-time |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| developmentStatus | RegularAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskSpare->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskSpare->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetRegularAssetTypeTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Spare collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Create a new Regular Asset Type 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| regularAssetTypeTaskId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id | integer | int64 |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| preferredMaterialMasterId | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSpare->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | 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": "CreateRegularAssetTypeTaskSpare", "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/CreateRegularAssetTypeTaskSpareResourceActionRequest" } }, { "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/RegularAssetTypeTasks/{id}/Spares": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Get a collection of Regular Asset Type Task Spare resources for the Regular Asset Type 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 | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTypeTaskSpare->CostElement_Description | string | |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetRegularAssetTypeTaskSpareForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Spare collection", "schema": { "$ref": "#/definitions/GetSpareForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the permission set for changing the Regular Asset Type 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": "LookupRegularAssetTypeTaskSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareCommodity": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the Commodity for the Regular Asset Type 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": "LookupRegularAssetTypeTaskSpareCommodity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareCommodityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareCostElement": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the Cost Element for the Regular Asset Type 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": "LookupRegularAssetTypeTaskSpareCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the permission set for creating the Regular Asset Type 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": "LookupRegularAssetTypeTaskSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareMaterialMasterForCommodity": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the Material Master for the Regular Asset Type 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| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSpareMaterialMasterForCommodity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareMaterialMasterForCommodityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareMaterialMaster": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the Material Master for the Regular Asset Type 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| commodityId | MaterialMaster->Commodity_Id | integer | int64 |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the Regular Asset Type Task Spare for the Regular Asset Type 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSpareRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskSpareTaskRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Lookups/LookupRegularAssetTypeTaskSpareWithMaterialMaster": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Lookup the Material Master for the Regular Asset Type 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": "LookupRegularAssetTypeTaskSpareWithMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareWithMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Get a collection of Regular Asset Type 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| rulesLastChangedOn | RegularAssetTypeTaskSpare->RulesLastChangedOn | string | date-time |\r\n| createdByUserId | RegularAssetTypeTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskSpare->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSpare->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSpare->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSpare->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSpare->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSpare->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSpare->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Code | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpare->SequenceNumber | integer | int32 |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTypeTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTypeTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskSpare->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskRecordType | RegularAssetTypeTaskSpare->InheritedFrom_RegularAssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| isHistorical | RegularAssetTypeTaskSpare->IsHistorical | boolean | |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | RegularAssetTypeTaskSpare->Notes | string | |\r\n| preferredMaterialMasterId | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| preferredMaterialMasterCode | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Code | string | |\r\n| preferredMaterialMasterDescription | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Description | string | |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| recordType | RegularAssetTypeTaskSpare->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "BatchGetRegularAssetTypeTaskSpare", "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 Regular Asset Type 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 Regular Asset Type Task Spare collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/Batch": { "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Create a new collection of Regular Asset Type 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| regularAssetTypeTaskId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id | integer | int64 |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTypeTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| preferredMaterialMasterId | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSpare->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | 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": "BatchCreateRegularAssetTypeTaskSpare", "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/BatchCreateRegularAssetTypeTaskSpareResourceActionRequest" } }, { "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 - Regular Asset Type 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": [ "Regular Asset Type Task Spare" ], "summary": "Update a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| preferredMaterialMasterId | RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSpare->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| id | Min Value | >= 0| |\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": "BatchUpdateRegularAssetTypeTaskSpare", "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/BatchUpdateRegularAssetTypeTaskSpareResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Spare resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/Spares/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Spare resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/Spares/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Spare resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/Spares/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Spare resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/Spares/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Spare resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/Spares/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Change the IsActive status for an existing Regular Asset Type 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 | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSpare->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": "ChangeRegularAssetTypeTaskSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSpareIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Change the PermissionTree for an existing Regular Asset Type 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 | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSpare->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": "ChangeRegularAssetTypeTaskSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Spare resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/Spares/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSpare->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| 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": "BatchChangeRegularAssetTypeTaskSpareIsActive", "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/BatchChangeRegularAssetTypeTaskSpareIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=False)", "x-nullable": true }, { "type": "boolean", "name": "includeDetails", "in": "query", "description": "Include details 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/RegularAssetTypeTasks/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSpare->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskSparePermissionTree", "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/BatchChangeRegularAssetTypeTaskSparePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change is active operation (default=True)", "x-nullable": true }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/Spares/MatchBatch": { "patch": { "tags": [ "Regular Asset Type Task Spare" ], "summary": "Update a collection of existing Regular Asset Type Task Spare resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpare->Version | integer | int32 |\r\n| quantity | RegularAssetTypeTaskSpare->Quantity | number | decimal |\r\n| costElementId | RegularAssetTypeTaskSpare->CostElement_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 | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdateRegularAssetTypeTaskSpare", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateRegularAssetTypeTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Type 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/RegularAssetTypeTasks/Spares/RuleLinks/{id}": { "get": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Get a Regular Asset Type Task Spare Rule Link 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| developmentStatus | RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSpareRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSpareRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSpareRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSpareRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSpareRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSpareRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| ruleId | RegularAssetTypeTaskSpareRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskSpareRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskSpareRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeTaskSpareRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->SequenceNumber | integer | int32 |\r\n| createdByUserId | RegularAssetTypeTaskSpareRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSpareRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSpareRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSpareRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSpareRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| inheritedFromRuleId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeTaskSpareRuleLink->Notes | string | |\r\n| regularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareMaterialMasterId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareMaterialMasterCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Code | string | |\r\n| regularAssetTypeTaskSpareMaterialMasterDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Description | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Description | string | |\r\n", "operationId": "GetRegularAssetTypeTaskSpareRuleLink", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Rule Link Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Spare Rule Link", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSpareRuleLinkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Update an existing Regular Asset Type Task Spare Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskSpareRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskSpareRuleLink", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks": { "get": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Spare Rule Link 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 | RegularAssetTypeTaskSpareRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| regularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskSpareMaterialMasterCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Code | string | |\r\n| regularAssetTypeTaskSpareMaterialMasterDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Description | string | |\r\n| ruleId | RegularAssetTypeTaskSpareRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskSpareRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskSpareRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description | string | |\r\n| isActive | RegularAssetTypeTaskSpareRuleLink->IsActive | boolean | |\r\n| isInherited | RegularAssetTypeTaskSpareRuleLink->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskSpareRuleLinkCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Spare Rule Link collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSpareRuleLinkCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Create a new Regular Asset Type Task Spare Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskSpareRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSpareRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->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| regularAssetTypeTaskSpareId | Required | True | |\r\n| regularAssetTypeTaskSpareId | Nullable | False | |\r\n| regularAssetTypeTaskSpareId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskSpareRuleLink", "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/CreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Spares/{id}/RuleLinks": { "get": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Spare Rule Link resources for the Regular Asset Type 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 | RegularAssetTypeTaskSpareRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| regularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskSpareMaterialMasterCommodityCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Commodity_Code | string | |\r\n| regularAssetTypeTaskSpareMaterialMasterCommodityDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Commodity_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | RegularAssetTypeTaskSpareRuleLink->IsInherited | boolean | |\r\n| ruleId | RegularAssetTypeTaskSpareRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskSpareRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskSpareRuleLink->Rule_Description | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskSpareRuleLinkForRegularAssetTypeTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Spare Rule Link collection", "schema": { "$ref": "#/definitions/GetRuleLinkForRegularAssetTypeTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/RuleLinks/Lookups/LookupRegularAssetTypeTaskSpareRuleLinkRegularAssetTypeTaskSpare": { "get": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Lookup the Regular Asset Type Task Spare Rule Link for the Regular Asset Type Task Spare Rule Link.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSpare->Id | integer | int64 |\r\n| materialMasterId | RegularAssetTypeTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTypeTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTypeTaskSpare->MaterialMaster_Description | string | |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Description | string | |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSpareRuleLinkRegularAssetTypeTaskSpare", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Spare collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskSpareRuleLinkTaskRegularAssetTypeTaskSpareLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/RuleLinks/Lookups/LookupRegularAssetTypeTaskSpareRuleLinkRule": { "get": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Lookup the Rule for the Regular Asset Type Task Spare Rule Link.", "description": "### Response Body\r\n#### Payload\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| code | Rule->Code | string | |\r\n| description | Rule->Description | string | |\r\n| ruleText | Rule->RuleText | string | |\r\n| ruleCategoryCode | Rule->RuleCategory_Code | string | |\r\n| ruleCategoryDescription | Rule->RuleCategory_Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSpareRuleLinkRule", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSpareRuleLinkRuleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/RuleLinks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Get a collection of Regular Asset Type Task Spare Rule Link 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| developmentStatus | RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSpareRuleLink->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSpareRuleLink->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSpareRuleLink->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSpareRuleLink->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSpareRuleLink->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSpareRuleLink->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| ruleId | RegularAssetTypeTaskSpareRuleLink->Rule_Id | integer | int64 |\r\n| ruleCode | RegularAssetTypeTaskSpareRuleLink->Rule_Code | string | |\r\n| ruleDescription | RegularAssetTypeTaskSpareRuleLink->Rule_Description | string | |\r\n| ruleRuleText | RegularAssetTypeTaskSpareRuleLink->Rule_RuleText | string | |\r\n| ruleRuleCategoryId | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id | integer | int64 |\r\n| ruleRuleCategoryCode | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code | string | |\r\n| ruleRuleCategoryDescription | RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->SequenceNumber | integer | int32 |\r\n| createdByUserId | RegularAssetTypeTaskSpareRuleLink->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSpareRuleLink->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSpareRuleLink->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSpareRuleLink->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSpareRuleLink->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| inheritedFromId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| inheritedFromRuleId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Id | integer | int64 |\r\n| inheritedFromRuleCode | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Code | string | |\r\n| inheritedFromRuleDescription | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Description | string | |\r\n| inheritedFromRuleRuleCategoryId | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Id | integer | int64 |\r\n| inheritedFromRuleRuleCategoryCode | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Code | string | |\r\n| inheritedFromRuleRuleCategoryDescription | RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Description | string | |\r\n| notes | RegularAssetTypeTaskSpareRuleLink->Notes | string | |\r\n| regularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareMaterialMasterId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareMaterialMasterCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Code | string | |\r\n| regularAssetTypeTaskSpareMaterialMasterDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Description | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Description | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id | integer | int64 |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Code | string | |\r\n| regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTypeTaskSpareRuleLink", "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 Regular Asset Type Task Spare Rule Link 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 Regular Asset Type Task Spare Rule Link collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskSpareRuleLinkResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/Spares/RuleLinks/Batch": { "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Create a new collection of Regular Asset Type Task Spare Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTypeTaskSpareId | RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id | integer | int64 |\r\n| ruleId | RegularAssetTypeTaskSpareRuleLink->Rule_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSpareRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->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| regularAssetTypeTaskSpareId | Required | True | |\r\n| regularAssetTypeTaskSpareId | Nullable | False | |\r\n| regularAssetTypeTaskSpareId | Min Value | > 0| |\r\n| ruleId | Required | True | |\r\n| ruleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskSpareRuleLink", "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/BatchCreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Spare Rule Link 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": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Update a collection of existing Regular Asset Type Task Spare Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSpareRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskSpareRuleLink->Notes | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSpareRuleLink->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskSpareRuleLink", "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/BatchUpdateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest" } }, { "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 - Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Regular Asset Type Task Spare Rule Link", "description": "", "operationId": "AcceptRegularAssetTypeTaskSpareRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Spare Rule Link resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskSpareRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Spare Rule Link resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskSpareRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Spare Rule Link resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskSpareRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Spare Rule Link resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskSpareRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Spare Rule Link resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSpareRuleLink->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": "ChangeRegularAssetTypeTaskSpareRuleLinkIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Rule Link Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSpareRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/Spares/RuleLinks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Regular Asset Type Task Spare Rule Link", "description": "", "operationId": "RejectRegularAssetTypeTaskSpareRuleLinkDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Spare Rule Link 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/RegularAssetTypeTasks/Spares/RuleLinks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Spare Rule Link" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Spare Rule Link resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeTaskSpareRuleLink->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSpareRuleLink->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSpareRuleLink->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| 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": "BatchChangeRegularAssetTypeTaskSpareRuleLinkIsActive", "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/BatchChangeRegularAssetTypeTaskSpareRuleLinkIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/SubTasks/{id}": { "get": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Get a Regular Asset Type Task Sub Task resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| createdByUserId | RegularAssetTypeTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSubTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskSubTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSubTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSubTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSubTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSubTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSubTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskSubTask->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskRecordType | RegularAssetTypeTaskSubTask->InheritedFrom_RegularAssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n| recordType | RegularAssetTypeTaskSubTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "GetRegularAssetTypeTaskSubTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Sub Task", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSubTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Update an existing Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 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": "UpdateRegularAssetTypeTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSubTaskResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks/SubTasks": { "get": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Get a collection of Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| isActive | RegularAssetTypeTaskSubTask->IsActive | boolean | |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| developmentStatus | RegularAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeTaskSubTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Sub Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSubTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Create a new Regular Asset Type 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| regularAssetTypeTaskId | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskSubTask", "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/CreateRegularAssetTypeTaskSubTaskResourceActionRequest" } }, { "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/RegularAssetTypeTasks/{id}/SubTasks": { "get": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Get a collection of Regular Asset Type Task Sub Task resources for the Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| developmentStatus | RegularAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| inheritedFromId | RegularAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n", "operationId": "GetRegularAssetTypeTaskSubTaskForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Sub Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSubTaskForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SubTasks/Lookups/LookupRegularAssetTypeTaskSubTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Lookup the permission set for changing the Regular Asset Type 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": "LookupRegularAssetTypeTaskSubTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SubTasks/Lookups/LookupRegularAssetTypeTaskSubTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Lookup the permission set for creating the Regular Asset Type 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": "LookupRegularAssetTypeTaskSubTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SubTasks/Lookups/LookupRegularAssetTypeTaskSubTaskRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Lookup the Regular Asset Type Task Sub Task for the Regular Asset Type 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSubTaskRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskSubTaskRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SubTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Get a collection of Regular Asset Type Task Sub Task resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| createdByUserId | RegularAssetTypeTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSubTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskSubTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSubTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSubTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSubTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSubTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSubTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSubTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSubTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| inheritedFromId | RegularAssetTypeTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTypeTaskSubTask->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskRecordType | RegularAssetTypeTaskSubTask->InheritedFrom_RegularAssetTypeTask_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n| recordType | RegularAssetTypeTaskSubTask->RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n", "operationId": "BatchGetRegularAssetTypeTaskSubTask", "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 Regular Asset Type 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 Regular Asset Type Task Sub Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskSubTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SubTasks/Batch": { "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Create a new collection of Regular Asset Type 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| regularAssetTypeTaskId | RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | string | |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTypeTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskSubTask", "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/BatchCreateRegularAssetTypeTaskSubTaskResourceActionRequest" } }, { "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 - Regular Asset Type 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": [ "Regular Asset Type Task Sub Task" ], "summary": "Update a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTypeTaskSubTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTypeTaskSubTask->Notes | string | |\r\n| code | RegularAssetTypeTaskSubTask->Code | string | |\r\n| description | RegularAssetTypeTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTypeTaskSubTask->AlternativeDescription | 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| 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": "BatchUpdateRegularAssetTypeTaskSubTask", "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/BatchUpdateRegularAssetTypeTaskSubTaskResourceActionRequest" } }, { "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 - Regular Asset Type 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/RegularAssetTypeTasks/SubTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Sub Task resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Sub Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Sub Task resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/SubTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Sub Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type 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/RegularAssetTypeTasks/SubTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Sub Task resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/SubTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Change the IsActive status for an existing Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSubTask->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": "ChangeRegularAssetTypeTaskSubTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSubTaskIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/SubTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Change the PermissionTree for an existing Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSubTask->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": "ChangeRegularAssetTypeTaskSubTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSubTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/SubTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Sub Task resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type 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/RegularAssetTypeTasks/SubTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSubTask->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": "BatchChangeRegularAssetTypeTaskSubTaskIsActive", "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/BatchChangeRegularAssetTypeTaskSubTaskIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/SubTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Sub Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type 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 | RegularAssetTypeTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSubTask->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| id | Min Value | > 0| |\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": "BatchChangeRegularAssetTypeTaskSubTaskPermissionTree", "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/BatchChangeRegularAssetTypeTaskSubTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/SuppressedTasks/{id}": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Get a Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSuppressedTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSuppressedTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSuppressedTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSuppressedTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSuppressedTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSuppressedTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSuppressedTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskSuppressedTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskSuppressedTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSuppressedTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSuppressedTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSuppressedTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSuppressedTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSuppressedTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| inheritedFromId | RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSuppressedTask->Notes | string | |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| suppressedTaskIsActive | RegularAssetTypeTaskSuppressedTask->SuppressedTask_IsActive | boolean | |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n", "operationId": "GetRegularAssetTypeTaskSuppressedTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Type Task Suppressed Task", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSuppressedTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Update an existing Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| notes | RegularAssetTypeTaskSuppressedTask->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| suppressedTaskId | Min Value | > 0| |\r\n| suppressionPercentage | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0 |\r\n| suppressedDaysAfter | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n| suppressedDaysBefore | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n\r\n", "operationId": "UpdateRegularAssetTypeTaskSuppressedTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSuppressedTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Get a collection of Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTypeTaskSuppressedTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Description | string | |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| notes | RegularAssetTypeTaskSuppressedTask->Notes | string | |\r\n| developmentStatus | RegularAssetTypeTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskSuppressedTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task Suppressed Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTypeTaskSuppressedTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Create a new Regular Asset Type Task Suppressed 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| regularAssetTypeTaskId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSuppressedTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTypeTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | 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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| suppressedTaskId | Required | True | |\r\n| suppressedTaskId | Nullable | False | |\r\n| suppressedTaskId | Min Value | > 0| |\r\n| additionalNumberOfCyclesSuppressed | System Generated | true | If no value specified |\r\n| suppressionPercentage | System Generated | true | If no value specified |\r\n| suppressionPercentage | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0 |\r\n| suppressedDaysAfter | System Generated | true | If no value specified |\r\n| suppressedDaysAfter | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n| suppressedDaysBefore | System Generated | true | If no value specified |\r\n| suppressedDaysBefore | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n\r\n", "operationId": "CreateRegularAssetTypeTaskSuppressedTask", "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/CreateRegularAssetTypeTaskSuppressedTaskResourceActionRequest" } }, { "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/RegularAssetTypeTasks/{regularAssetTypeTaskId}/SuppressedTasks": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Get a collection of Suppressed Tasks for the Regular Asset Type 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 | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| notes | RegularAssetTypeTaskSuppressedTask->Notes | string | |\r\n| isInherited | RegularAssetTypeTaskSuppressedTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | RegularAssetTypeTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| createdOn | RegularAssetTypeTaskSuppressedTask->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTypeTaskSuppressedTask->ModifiedOn | string | date-time |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n", "operationId": "GetRegularAssetTypeTaskSuppressedTaskForRegularAssetTypeTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTypeTaskId", "in": "path", "required": true, "description": "Regular Asset Type 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 Regular Asset Type Task Suppressed Task collection", "schema": { "$ref": "#/definitions/GetSuppressedTaskForRegularAssetTypeTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SuppressedTasks/Lookups/LookupRegularAssetTypeTaskSuppressedTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Lookup the permission set for changing the Regular Asset Type Task Suppressed 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": "LookupRegularAssetTypeTaskSuppressedTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SuppressedTasks/Lookups/LookupRegularAssetTypeTaskSuppressedTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Lookup the permission set for creating the Regular Asset Type Task Suppressed 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": "LookupRegularAssetTypeTaskSuppressedTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTypeTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SuppressedTasks/Lookups/LookupRegularAssetTypeTaskSuppressedTaskRegularAssetTypeTask": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Lookup the Regular Asset Type Task Suppressed Task for the Regular Asset Type Task Suppressed 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSuppressedTaskRegularAssetTypeTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskSuppressedTaskRegularAssetTypeTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SuppressedTasks/Lookups/LookupRegularAssetTypeTaskSuppressedTaskSuppressedTask": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Lookup the Regular Asset Type Task Suppressed Task for the Regular Asset Type Task Suppressed 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 | RegularAssetTypeTask->Id | integer | int64 |\r\n| code | RegularAssetTypeTask->Code | string | |\r\n| description | RegularAssetTypeTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTypeTaskSuppressedTaskSuppressedTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Type Task collection", "schema": { "$ref": "#/definitions/RegularAssetTypeTaskSuppressedTaskSuppressedTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SuppressedTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Get a collection of Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTypeTaskSuppressedTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTypeTaskSuppressedTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTypeTaskSuppressedTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTypeTaskSuppressedTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTypeTaskSuppressedTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTypeTaskSuppressedTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTypeTaskSuppressedTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTypeTaskSuppressedTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTypeTaskSuppressedTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTypeTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| id | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| isActive | RegularAssetTypeTaskSuppressedTask->IsActive | boolean | |\r\n| isBackup | RegularAssetTypeTaskSuppressedTask->IsBackup | boolean | |\r\n| isInherited | RegularAssetTypeTaskSuppressedTask->IsInherited | boolean | |\r\n| lastConfirmedOn | RegularAssetTypeTaskSuppressedTask->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | RegularAssetTypeTaskSuppressedTask->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| regularAssetTypeTaskId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| regularAssetTypeTaskCode | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Code | string | |\r\n| regularAssetTypeTaskDescription | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Description | string | |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| inheritedFromId | RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSuppressedTask->Notes | string | |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| suppressedTaskIsActive | RegularAssetTypeTaskSuppressedTask->SuppressedTask_IsActive | boolean | |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n", "operationId": "BatchGetRegularAssetTypeTaskSuppressedTask", "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 Regular Asset Type Task Suppressed 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 Regular Asset Type Task Suppressed Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTypeTaskSuppressedTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTypeTasks/SuppressedTasks/Batch": { "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Create a new collection of Regular Asset Type Task Suppressed 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| regularAssetTypeTaskId | RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id | integer | int64 |\r\n| notes | RegularAssetTypeTaskSuppressedTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTypeTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | 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| regularAssetTypeTaskId | Required | True | |\r\n| regularAssetTypeTaskId | Nullable | False | |\r\n| regularAssetTypeTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| suppressedTaskId | Required | True | |\r\n| suppressedTaskId | Nullable | False | |\r\n| suppressedTaskId | Min Value | > 0| |\r\n| additionalNumberOfCyclesSuppressed | System Generated | true | If no value specified |\r\n| suppressionPercentage | System Generated | true | If no value specified |\r\n| suppressionPercentage | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0 |\r\n| suppressedDaysAfter | System Generated | true | If no value specified |\r\n| suppressedDaysAfter | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n| suppressedDaysBefore | System Generated | true | If no value specified |\r\n| suppressedDaysBefore | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n\r\n", "operationId": "BatchCreateRegularAssetTypeTaskSuppressedTask", "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/BatchCreateRegularAssetTypeTaskSuppressedTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Suppressed 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": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Update a collection of existing Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| suppressedTaskId | RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTypeTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| notes | RegularAssetTypeTaskSuppressedTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| suppressedTaskId | Min Value | > 0| |\r\n| suppressionPercentage | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0 |\r\n| suppressedDaysAfter | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n| suppressedDaysBefore | Nullable | False | RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTypeTaskSuppressedTask", "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/BatchUpdateRegularAssetTypeTaskSuppressedTaskResourceActionRequest" } }, { "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 - Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Accept the Development Status for an existing Regular Asset Type Task Suppressed Task resource.", "description": "", "operationId": "AcceptRegularAssetTypeTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Type Task Suppressed Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTypeTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Change the Development Status for the collection of existing Regular Asset Type Task Suppressed Task resource id's.", "description": "", "operationId": "BatchChangeRegularAssetTypeTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Type Task Suppressed Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTypeTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Change the Development Status for an existing Regular Asset Type Task Suppressed Task resource.", "description": "", "operationId": "ChangeRegularAssetTypeTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Change the IsActive status for an existing Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSuppressedTask->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": "ChangeRegularAssetTypeTaskSuppressedTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSuppressedTaskIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/SuppressedTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Change the PermissionTree for an existing Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSuppressedTask->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": "ChangeRegularAssetTypeTaskSuppressedTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSuppressedTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/RegularAssetTypeTasks/SuppressedTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Reject the Development Status for an existing Regular Asset Type Task Suppressed Task resource.", "description": "", "operationId": "RejectRegularAssetTypeTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Type Task Suppressed 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/RegularAssetTypeTasks/SuppressedTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| isActive | RegularAssetTypeTaskSuppressedTask->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| 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": "BatchChangeRegularAssetTypeTaskSuppressedTaskIsActive", "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/BatchChangeRegularAssetTypeTaskSuppressedTaskIsActiveResourceActionRequest" } }, { "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/RegularAssetTypeTasks/SuppressedTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Type Task Suppressed Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Type Task Suppressed 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 | RegularAssetTypeTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTypeTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTypeTaskSuppressedTask->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| id | Min Value | > 0| |\r\n| id | Min Value | >= 0| |\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": "BatchChangeRegularAssetTypeTaskSuppressedTaskPermissionTree", "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/BatchChangeRegularAssetTypeTaskSuppressedTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/Attributes/{id}": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Get a Standard Task Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inheritedFromId | StandardTaskAttribute->InheritedFrom_Id | integer | int64 |\r\n| standardTaskId | StandardTaskAttribute->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskAttribute->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskAttribute->StandardTask_Description | string | |\r\n| developmentStatus | StandardTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | StandardTaskAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | StandardTaskAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | StandardTaskAttribute->IsInherited | boolean | |\r\n| createdByUserId | StandardTaskAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskAttribute->CreatedOn | string | date-time |\r\n| isActive | StandardTaskAttribute->IsActive | boolean | |\r\n| modifiedByUserId | StandardTaskAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | StandardTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskAttribute->PermissionTree_Description | string | |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| id | StandardTaskAttribute->Id | integer | int64 |\r\n| attributeId | StandardTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StandardTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | StandardTaskAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | StandardTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | StandardTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | StandardTaskAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | StandardTaskAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | StandardTaskAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | StandardTaskAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | StandardTaskAttribute->Notes | string | |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StandardTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StandardTaskAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n", "operationId": "GetStandardTaskAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Attribute", "schema": { "$ref": "#/definitions/GetStandardTaskAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Attribute" ], "summary": "Update an existing Standard Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateStandardTaskAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateStandardTaskAttributeResourceActionRequest" } }, { "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 Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{standardTaskId}/Attributes": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Get a collection of Standard Task Attribute 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 | StandardTaskAttribute->Id | integer | int64 |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | StandardTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | StandardTaskAttribute->IsInherited | boolean | |\r\n| attributeId | StandardTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StandardTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | StandardTaskAttribute->Attribute_Description | string | |\r\n| attributeDataType | StandardTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StandardTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StandardTaskAttribute->PredefinedValue_Value | object | composite |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n| notes | StandardTaskAttribute->Notes | string | |\r\n| createdOn | StandardTaskAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | StandardTaskAttribute->ModifiedOn | string | date-time |\r\n| lastConfirmedOn | StandardTaskAttribute->LastConfirmedOn | string | date-time |\r\n", "operationId": "GetStandardTaskAttributeCollectionForStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "standardTaskId", "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 Attribute collection", "schema": { "$ref": "#/definitions/GetStandardTaskAttributeCollectionForStandardTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Get a collection of Standard Task Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskAttribute->Id | integer | int64 |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| standardTaskCode | StandardTaskAttribute->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskAttribute->StandardTask_Description | string | |\r\n| standardTaskAlternativeDescription | StandardTaskAttribute->StandardTask_AlternativeDescription | string | |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | StandardTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | StandardTaskAttribute->IsInherited | boolean | |\r\n| attributeId | StandardTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StandardTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | StandardTaskAttribute->Attribute_Description | string | |\r\n| attributeDataType | StandardTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StandardTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StandardTaskAttribute->PredefinedValue_Value | object | composite |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n| notes | StandardTaskAttribute->Notes | string | |\r\n| createdOn | StandardTaskAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | StandardTaskAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetStandardTaskAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Attribute collection", "schema": { "$ref": "#/definitions/GetStandardTaskAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Standard Task Attribute" ], "summary": "Create a new Standard Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskAttribute->StandardTask_Id | integer | int64 |\r\n| attributeId | StandardTaskAttribute->Attribute_Id | integer | int64 |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskAttribute->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| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateStandardTaskAttribute", "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/CreateStandardTaskAttributeResourceActionRequest" } }, { "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/Attributes/Lookups/LookupStandardTaskAttributeAllowedValue": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Standard Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupStandardTaskAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/StandardTaskAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes/Lookups/LookupStandardTaskAttribute": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Lookup the Attribute for the Standard Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupStandardTaskAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/StandardTaskAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes/Lookups/LookupStandardTaskAttributeChangePermissionTree": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Lookup the permission set for changing the Standard Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes/Lookups/LookupStandardTaskAttributeInsertPermissionTree": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Lookup the permission set for creating the Standard Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes/Lookups/LookupStandardTaskAttributeStandardTask": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Lookup the Standard Task Attribute for the Standard Task Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTask->Id | integer | int64 |\r\n| code | StandardTask->Code | string | |\r\n| description | StandardTask->Description | string | |\r\n", "operationId": "LookupStandardTaskAttributeStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskAttributeStandardTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes/Batch/{ids}": { "get": { "tags": [ "Standard Task Attribute" ], "summary": "Get a collection of Standard Task Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inheritedFromId | StandardTaskAttribute->InheritedFrom_Id | integer | int64 |\r\n| standardTaskId | StandardTaskAttribute->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskAttribute->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskAttribute->StandardTask_Description | string | |\r\n| developmentStatus | StandardTaskAttribute->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | StandardTaskAttribute->IsBackup | boolean | |\r\n| lastConfirmedOn | StandardTaskAttribute->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskAttribute->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | StandardTaskAttribute->IsInherited | boolean | |\r\n| createdByUserId | StandardTaskAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskAttribute->CreatedOn | string | date-time |\r\n| isActive | StandardTaskAttribute->IsActive | boolean | |\r\n| modifiedByUserId | StandardTaskAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | StandardTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskAttribute->PermissionTree_Description | string | |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| id | StandardTaskAttribute->Id | integer | int64 |\r\n| attributeId | StandardTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | StandardTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | StandardTaskAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | StandardTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | StandardTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | StandardTaskAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | StandardTaskAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | StandardTaskAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | StandardTaskAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | StandardTaskAttribute->Notes | string | |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | StandardTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | StandardTaskAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n", "operationId": "BatchGetStandardTaskAttribute", "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 Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Attribute collection", "schema": { "$ref": "#/definitions/BatchGetStandardTaskAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes/Batch": { "post": { "tags": [ "Standard Task Attribute" ], "summary": "Create a new collection of Standard Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskAttribute->StandardTask_Id | integer | int64 |\r\n| attributeId | StandardTaskAttribute->Attribute_Id | integer | int64 |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskAttribute->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| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateStandardTaskAttribute", "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/BatchCreateStandardTaskAttributeResourceActionRequest" } }, { "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 Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Attribute" ], "summary": "Update a collection of existing Standard Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskAttribute->Id | integer | int64 |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| value | StandardTaskAttribute->Value | object | composite |\r\n| predefinedValueId | StandardTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateStandardTaskAttribute", "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/BatchUpdateStandardTaskAttributeResourceActionRequest" } }, { "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 Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Attribute" ], "summary": "Accept the Development Status for an existing Standard Task Attribute resource.", "description": "", "operationId": "AcceptStandardTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Attribute 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/Attributes/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Attribute" ], "summary": "Accept the Development Status for the collection of existing Standard Task Attribute resource id's.", "description": "", "operationId": "BatchAcceptStandardTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Attribute 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/Attributes/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Attribute" ], "summary": "Change the Development Status for the collection of existing Standard Task Attribute resource id's.", "description": "", "operationId": "BatchChangeStandardTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Attribute 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/Attributes/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Attribute" ], "summary": "Reject the Development Status for the collection of existing Standard Task Attribute resource id's.", "description": "", "operationId": "BatchRejectStandardTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Attribute 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/Attributes/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Attribute" ], "summary": "Change the Development Status for an existing Standard Task Attribute resource.", "description": "", "operationId": "ChangeStandardTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Attribute 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/Attributes/{id}/Active": { "patch": { "tags": [ "Standard Task Attribute" ], "summary": "Change the IsActive status for an existing Standard Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| isActive | StandardTaskAttribute->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": "ChangeStandardTaskAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskAttributeIsActiveResourceActionRequest" } }, { "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/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Standard Task Attribute" ], "summary": "Change the PermissionTree for an existing Standard Task Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskAttribute->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": "ChangeStandardTaskAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Attribute" ], "summary": "Reject the Development Status for an existing Standard Task Attribute resource.", "description": "", "operationId": "RejectStandardTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Attribute 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/Attributes/Batch/Active": { "patch": { "tags": [ "Standard Task Attribute" ], "summary": "Change the IsActive status for a collection of existing Standard Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskAttribute->Id | integer | int64 |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| isActive | StandardTaskAttribute->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": "BatchChangeStandardTaskAttributeIsActive", "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/BatchChangeStandardTaskAttributeIsActiveResourceActionRequest" } }, { "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/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Standard Task Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Standard Task Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskAttribute->Id | integer | int64 |\r\n| version | StandardTaskAttribute->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskAttribute->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": "BatchChangeStandardTaskAttributePermissionTree", "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/BatchChangeStandardTaskAttributePermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/Documents/{id}": { "get": { "tags": [ "Standard Task Document" ], "summary": "Get a Standard Task Document resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| inheritedFromId | StandardTaskDocument->InheritedFrom_Id | integer | int64 |\r\n| standardTaskId | StandardTaskDocument->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskDocument->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskDocument->StandardTask_Description | string | |\r\n| developmentStatus | StandardTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | StandardTaskDocument->IsBackup | boolean | |\r\n| isInherited | StandardTaskDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | StandardTaskDocument->IsActive | boolean | |\r\n| createdByUserId | StandardTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskDocument->ModifiedOn | string | date-time |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskDocument->PermissionTree_Description | string | |\r\n| id | StandardTaskDocument->Id | integer | int64 |\r\n| documentRecordId | StandardTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StandardTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StandardTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StandardTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | StandardTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | StandardTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | StandardTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | StandardTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | StandardTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | StandardTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | StandardTaskDocument->Notes | string | |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetStandardTaskDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Document", "schema": { "$ref": "#/definitions/GetStandardTaskDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Document" ], "summary": "Update an existing Standard Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskDocument->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| copyDocumentLink | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateStandardTaskDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateStandardTaskDocumentResourceActionRequest" } }, { "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 Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Standard Task Document" ], "summary": "Delete an existing Standard Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskDocument->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": "DeleteStandardTaskDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteStandardTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Document was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/{standardTaskId}/Documents": { "get": { "tags": [ "Standard Task Document" ], "summary": "Get a collection of Standard Task Document 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 | StandardTaskDocument->Id | integer | int64 |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | StandardTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | StandardTaskDocument->IsInherited | boolean | |\r\n| documentRecordId | StandardTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StandardTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StandardTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StandardTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | StandardTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | StandardTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | StandardTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | StandardTaskDocument->Notes | string | |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| createdOn | StandardTaskDocument->CreatedOn | string | date-time |\r\n| modifiedOn | StandardTaskDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetStandardTaskDocumentCollectionForStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "standardTaskId", "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 Document collection", "schema": { "$ref": "#/definitions/GetStandardTaskDocumentCollectionForStandardTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Documents": { "get": { "tags": [ "Standard Task Document" ], "summary": "Get a collection of Standard Task Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskDocument->Id | integer | int64 |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| standardTaskCode | StandardTaskDocument->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskDocument->StandardTask_Description | string | |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | StandardTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isInherited | StandardTaskDocument->IsInherited | boolean | |\r\n| documentRecordId | StandardTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StandardTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StandardTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StandardTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | StandardTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | StandardTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | StandardTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| notes | StandardTaskDocument->Notes | string | |\r\n| createdOn | StandardTaskDocument->CreatedOn | string | date-time |\r\n| modifiedOn | StandardTaskDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetStandardTaskDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Document collection", "schema": { "$ref": "#/definitions/GetStandardTaskDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Standard Task Document" ], "summary": "Create a new Standard Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskDocument->StandardTask_Id | integer | int64 |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | StandardTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskDocument->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| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| copyDocumentLink | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateStandardTaskDocument", "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/CreateStandardTaskDocumentResourceActionRequest" } }, { "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/Documents/Lookups/LookupStandardTaskDocumentChangePermissionTree": { "get": { "tags": [ "Standard Task Document" ], "summary": "Lookup the permission set for changing the Standard Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Documents/Lookups/LookupStandardTaskDocument": { "get": { "tags": [ "Standard Task Document" ], "summary": "Lookup the Document Record for the Standard Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupStandardTaskDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/StandardTaskDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Documents/Lookups/LookupStandardTaskDocumentInsertPermissionTree": { "get": { "tags": [ "Standard Task Document" ], "summary": "Lookup the permission set for creating the Standard Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupStandardTaskDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Documents/Lookups/LookupStandardTaskDocumentStandardTask": { "get": { "tags": [ "Standard Task Document" ], "summary": "Lookup the Standard Task Document for the Standard Task Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTask->Id | integer | int64 |\r\n| code | StandardTask->Code | string | |\r\n| description | StandardTask->Description | string | |\r\n", "operationId": "LookupStandardTaskDocumentStandardTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/StandardTaskDocumentStandardTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Documents/Batch/{ids}": { "get": { "tags": [ "Standard Task Document" ], "summary": "Get a collection of Standard Task Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| inheritedFromId | StandardTaskDocument->InheritedFrom_Id | integer | int64 |\r\n| standardTaskId | StandardTaskDocument->StandardTask_Id | integer | int64 |\r\n| standardTaskCode | StandardTaskDocument->StandardTask_Code | string | |\r\n| standardTaskDescription | StandardTaskDocument->StandardTask_Description | string | |\r\n| developmentStatus | StandardTaskDocument->DevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isBackup | StandardTaskDocument->IsBackup | boolean | |\r\n| isInherited | StandardTaskDocument->IsInherited | boolean | |\r\n| lastConfirmedOn | StandardTaskDocument->LastConfirmedOn | string | date-time |\r\n| previousDevelopmentStatus | StandardTaskDocument->PreviousDevelopmentStatus | string (Allowed values: [NewUnderDevelopment, NewAwaitingConfirmation, ModifiedUnderDevelopment, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed]) | enum |\r\n| isActive | StandardTaskDocument->IsActive | boolean | |\r\n| createdByUserId | StandardTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | StandardTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | StandardTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | StandardTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | StandardTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | StandardTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | StandardTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | StandardTaskDocument->ModifiedOn | string | date-time |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | StandardTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | StandardTaskDocument->PermissionTree_Description | string | |\r\n| id | StandardTaskDocument->Id | integer | int64 |\r\n| documentRecordId | StandardTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | StandardTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | StandardTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | StandardTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | StandardTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | StandardTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | StandardTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | StandardTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | StandardTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | StandardTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | StandardTaskDocument->Notes | string | |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetStandardTaskDocument", "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 Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Standard Task Document collection", "schema": { "$ref": "#/definitions/BatchGetStandardTaskDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Documents/Batch": { "post": { "tags": [ "Standard Task Document" ], "summary": "Create a new collection of Standard Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| standardTaskId | StandardTaskDocument->StandardTask_Id | integer | int64 |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | StandardTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | StandardTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskDocument->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| standardTaskId | Required | True | |\r\n| standardTaskId | Nullable | False | |\r\n| copyDocumentLink | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateStandardTaskDocument", "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/BatchCreateStandardTaskDocumentResourceActionRequest" } }, { "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 Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Standard Task Document" ], "summary": "Update a collection of existing Standard Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| copyDocumentLink | StandardTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| id | StandardTaskDocument->Id | integer | int64 |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | StandardTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | StandardTaskDocument->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| copyDocumentLink | Nullable | False | |\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\r\n", "operationId": "BatchUpdateStandardTaskDocument", "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/BatchUpdateStandardTaskDocumentResourceActionRequest" } }, { "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 Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Standard Task Document" ], "summary": "Delete a collection of existing Standard Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskDocument->Id | integer | int64 |\r\n| version | StandardTaskDocument->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteStandardTaskDocument", "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/BatchDeleteStandardTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Standard Task Document batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/StandardTasks/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Document" ], "summary": "Accept the Development Status for an existing Standard Task Document resource.", "description": "", "operationId": "AcceptStandardTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document 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/Documents/{ids}/Batch/DevelopmentStatus/Accept": { "post": { "tags": [ "Standard Task Document" ], "summary": "Accept the Development Status for the collection of existing Standard Task Document resource id's.", "description": "", "operationId": "BatchAcceptStandardTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Document 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/Documents/{ids}/Batch/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Document" ], "summary": "Change the Development Status for the collection of existing Standard Task Document resource id's.", "description": "", "operationId": "BatchChangeStandardTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Document 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/Documents/{ids}/Batch/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Document" ], "summary": "Reject the Development Status for the collection of existing Standard Task Document resource id's.", "description": "", "operationId": "BatchRejectStandardTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Standard Task Document 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/Documents/{id}/DevelopmentStatus/Set/{developmentStatusAction}": { "post": { "tags": [ "Standard Task Document" ], "summary": "Change the Development Status for an existing Standard Task Document resource.", "description": "", "operationId": "ChangeStandardTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document 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/Documents/{id}/Active": { "patch": { "tags": [ "Standard Task Document" ], "summary": "Change the IsActive status for an existing Standard Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| isActive | StandardTaskDocument->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": "ChangeStandardTaskDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskDocumentIsActiveResourceActionRequest" } }, { "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/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Standard Task Document" ], "summary": "Change the PermissionTree for an existing Standard Task Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskDocument->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": "ChangeStandardTaskDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeStandardTaskDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Standard Task Document" ], "summary": "Reject the Development Status for an existing Standard Task Document resource.", "description": "", "operationId": "RejectStandardTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Standard Task Document 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/Documents/Batch/Active": { "patch": { "tags": [ "Standard Task Document" ], "summary": "Change the IsActive status for a collection of existing Standard Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskDocument->Id | integer | int64 |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| isActive | StandardTaskDocument->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": "BatchChangeStandardTaskDocumentIsActive", "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/BatchChangeStandardTaskDocumentIsActiveResourceActionRequest" } }, { "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/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Standard Task Document" ], "summary": "Change the PermissionTree status for a collection of existing Standard Task Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StandardTaskDocument->Id | integer | int64 |\r\n| version | StandardTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | StandardTaskDocument->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| id | Min Value | >= 0| |\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": "BatchChangeStandardTaskDocumentPermissionTree", "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/BatchChangeStandardTaskDocumentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeDescendants", "in": "query", "description": "Include descendants when executing the is active operation (default=True)", "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" } } } } }, "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" ] }, "GetAssetTypeFmecaResourceActionResponse": { "title": "GetAssetTypeFmecaResourceActionResponse", "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": "GetAssetTypeFmecaResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFmeca->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFmeca->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFmeca->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->PermissionTree_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeNearestRegularAssetTypeId": { "title": "assetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_NearestRegularAssetType_Id" }, "assetTypeNearestRegularAssetTypeCode": { "title": "assetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_NearestRegularAssetType_Code" }, "assetTypeNearestRegularAssetTypeDescription": { "title": "assetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_NearestRegularAssetType_Description" }, "assetTypeFunctionId": { "title": "assetTypeFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Id" }, "assetTypeFunctionCode": { "title": "assetTypeFunctionCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Code" }, "assetTypeFunctionDescription": { "title": "assetTypeFunctionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Description" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentAssetTypeId": { "title": "componentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_AssetType_Id" }, "componentAssetTypeCode": { "title": "componentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_AssetType_Code" }, "componentAssetTypeDescription": { "title": "componentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_AssetType_Description" }, "componentAssetTypeRecordType": { "title": "componentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "componentAssetTypeNearestRegularAssetTypeId": { "title": "componentAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Id" }, "componentAssetTypeNearestRegularAssetTypeCode": { "title": "componentAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Code" }, "componentAssetTypeNearestRegularAssetTypeDescription": { "title": "componentAssetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_AssetType_NearestRegularAssetType_Description" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCause_Code" }, "failureCauseDescription": { "title": "failureCauseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCause_Description" }, "failureCauseAdditionalInformation": { "title": "failureCauseAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCauseAdditionalInformation" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCauseType_Id", "x-NullExpression": "AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCauseType_Description" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Code" }, "failureMechanismDescription": { "title": "failureMechanismDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Description" }, "failureMechanismAdditionalInformation": { "title": "failureMechanismAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanismAdditionalInformation" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanismType_Id", "x-NullExpression": "AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureCauseType_Id eq NULL" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanismType_Description" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMode_Code" }, "failureModeDescription": { "title": "failureModeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMode_Description" }, "failureModeAdditionalInformation": { "title": "failureModeAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureModeAdditionalInformation" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureModeType_Id", "x-NullExpression": "AssetTypeFmeca->FailureCauseType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureModeType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->InheritedFrom_Id" }, "isFailureEvident": { "title": "isFailureEvident", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->IsFailureEvident" }, "isLegacy": { "title": "isLegacy", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->IsLegacy" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Notes" }, "repairTypeId": { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairType_Id" }, "repairTypeCode": { "title": "repairTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairType_Code" }, "repairTypeDescription": { "title": "repairTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairType_Description" }, "repairTypeAdditionalInformation": { "title": "repairTypeAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairTypeAdditionalInformation" }, "warningEffects": { "title": "warningEffects", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->WarningEffects" } } }, "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" } } }, "GetAssetTypeFmecaCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_Code" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFmeca->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetTypeFunctionDescription": { "title": "assetTypeFunctionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Description" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_Code" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFmeca->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMode_Code" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Code" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCause_Code" }, "repairTypeCode": { "title": "repairTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->RepairType_Code" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->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" } } } }, "GetAssetTypeFmecaForInPlaceAssetTypeCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaForInPlaceAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaForInPlaceAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaForInPlaceAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeFunctionCode": { "title": "assetTypeFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Code" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMode_Code" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Code" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->InheritedFrom_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" } } } }, "GetAssetTypeFmecaForPlaceholderAssetTypeCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaForPlaceholderAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaForPlaceholderAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaForPlaceholderAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeFunctionCode": { "title": "assetTypeFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Code" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMode_Code" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Code" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->InheritedFrom_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" } } } }, "GetAssetTypeFmecaForPlaceholderAssetTypeComponentCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaForPlaceholderAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaForPlaceholderAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaForPlaceholderAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeFunctionCode": { "title": "assetTypeFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Code" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMode_Code" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Code" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->InheritedFrom_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" } } } }, "GetAssetTypeFmecaForRegularAssetTypeCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaForRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaForRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaForRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeFunctionCode": { "title": "assetTypeFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Code" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMode_Code" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Code" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->InheritedFrom_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" } } } }, "GetAssetTypeFmecaForRegularAssetTypeComponentCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaForRegularAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaForRegularAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaForRegularAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeFunctionCode": { "title": "assetTypeFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Code" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMode_Code" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Code" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->InheritedFrom_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" } } } }, "AssetTypeFmecaAssetTypeFunctionFromAssetTypeComponentLookupResourceActionResponse": { "title": "AssetTypeFmecaAssetTypeFunctionFromAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaAssetTypeFunctionFromAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaAssetTypeFunctionFromAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->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" } } } }, "AssetTypeFmecaAssetTypeFunctionFromAssetTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaAssetTypeFunctionFromAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaAssetTypeFunctionFromAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaAssetTypeFunctionFromAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->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" } } } }, "AssetTypeFmecaRegularAssetTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaChangePermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFmecaChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFmecaComponentLookupResourceActionResponse": { "title": "AssetTypeFmecaComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponseItemProperties", "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaFailureCauseLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureCauseLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureCauseLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureCauseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->Description" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureCause->FailureCauseType_Id" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureCause->FailureCauseType_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaFailureCauseTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureCauseTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureCauseTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureCauseTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFmecaFailureMechanismFromAssetTypeFmecaFailureMechanismTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureMechanismFromAssetTypeFmecaFailureMechanismTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureMechanismFromAssetTypeFmecaFailureMechanismTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureMechanismFromAssetTypeFmecaFailureMechanismTypeLookupResourceActionResponseItemProperties", "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaFailureMechanismLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureMechanismLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureMechanismLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureMechanismLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->Description" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMechanism->FailureMechanismType_Id" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMechanism->FailureMechanismType_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaFailureMechanismTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureMechanismTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureMechanismTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureMechanismTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFmecaFailureModeFromFailureModeTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureModeFromFailureModeTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureModeFromFailureModeTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureModeFromFailureModeTypeLookupResourceActionResponseItemProperties", "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaFailureModeLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureModeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureModeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureModeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->Description" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FailureMode->FailureModeType_Id" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FailureMode->FailureModeType_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaFailureModeTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaFailureModeTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaFailureModeTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaFailureModeTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFmecaInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFmecaInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFmecaRepairTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaRepairTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaRepairTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaRepairTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RepairType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateAssetTypeFmecaResourceActionRequest": { "title": "CreateAssetTypeFmecaResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAssetTypeFmecaResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetTypeId" ], "properties": { "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AssetTypeFmeca->AssetType_Id" }, "assetTypeFunctionId": { "title": "assetTypeFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Id" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "AssetTypeFmeca->Component_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->SequenceNumber" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureModeType_Id", "x-NullExpression": "AssetTypeFmeca->FailureCauseType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMode_Id" }, "failureModeAdditionalInformation": { "title": "failureModeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureModeAdditionalInformation" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanismType_Id", "x-NullExpression": "AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureCauseType_Id eq NULL" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Id" }, "failureMechanismAdditionalInformation": { "title": "failureMechanismAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanismAdditionalInformation" }, "isFailureEvident": { "title": "isFailureEvident", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->IsFailureEvident" }, "warningEffects": { "title": "warningEffects", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->WarningEffects" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCauseType_Id", "x-NullExpression": "AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCause_Id" }, "failureCauseAdditionalInformation": { "title": "failureCauseAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCauseAdditionalInformation" }, "repairTypeId": { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairType_Id" }, "repairTypeAdditionalInformation": { "title": "repairTypeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairTypeAdditionalInformation" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->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" } } }, "UpdateAssetTypeFmecaResourceActionRequest": { "title": "UpdateAssetTypeFmecaResourceActionRequest", "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": "assetTypeFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetTypeFunction_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->SequenceNumber" }, { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureModeType_Id", "x-NullExpression": "AssetTypeFmeca->FailureCauseType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL" }, { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMode_Id" }, { "title": "failureModeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureModeAdditionalInformation" }, { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureMechanismType_Id", "x-NullExpression": "AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureCauseType_Id eq NULL" }, { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanism_Id" }, { "title": "failureMechanismAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureMechanismAdditionalInformation" }, { "title": "isFailureEvident", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->IsFailureEvident" }, { "title": "warningEffects", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->WarningEffects" }, { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmeca->FailureCauseType_Id", "x-NullExpression": "AssetTypeFmeca->FailureModeType_Id eq NULL AND AssetTypeFmeca->FailureMechanismType_Id eq NULL" }, { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCause_Id" }, { "title": "failureCauseAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->FailureCauseAdditionalInformation" }, { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairType_Id" }, { "title": "repairTypeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->RepairTypeAdditionalInformation" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Notes" } ] } } }, "BatchGetAssetTypeFmecaResourceAction": { "title": "BatchGetAssetTypeFmecaResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Type FMECA entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Type FMECA entities", "items": { "$ref": "#/definitions/GetAssetTypeFmecaResourceActionResponse" } }, "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" } } }, "BatchCreateAssetTypeFmecaResourceActionRequest": { "title": "BatchCreateAssetTypeFmecaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetTypeFmecaResourceActionRequest" } }, "BatchUpdateAssetTypeFmecaResourceActionRequest": { "title": "BatchUpdateAssetTypeFmecaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetTypeFmecaResourceActionRequest" } }, "ChangeAssetTypeFmecaIsActiveResourceActionRequest": { "title": "ChangeAssetTypeFmecaIsActiveResourceActionRequest", "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": "AssetTypeFmeca->IsActive" } ] } } }, "ChangeAssetTypeFmecaPermissionTreeResourceActionRequest": { "title": "ChangeAssetTypeFmecaPermissionTreeResourceActionRequest", "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": "AssetTypeFmeca->PermissionTree_Id" } ] } } }, "BatchChangeAssetTypeFmecaIsActiveResourceActionRequest": { "title": "BatchChangeAssetTypeFmecaIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFmecaIsActiveResourceActionRequest" } }, "BatchChangeAssetTypeFmecaPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetTypeFmecaPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFmecaPermissionTreeResourceActionRequest" } }, "GetAssetTypeFmecaTaskResourceActionResponse": { "title": "GetAssetTypeFmecaTaskResourceActionResponse", "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": "GetAssetTypeFmecaTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFmecaTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFmecaTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFmecaTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->PermissionTree_Description" }, "assetTypeFmecaId": { "title": "assetTypeFmecaId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_Id" }, "assetTypeFmecaAssetTypeId": { "title": "assetTypeFmecaAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Id" }, "assetTypeFmecaAssetTypeCode": { "title": "assetTypeFmecaAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Code" }, "assetTypeFmecaAssetTypeDescription": { "title": "assetTypeFmecaAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->Notes" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Component_Id" }, "regularAssetTypeTaskComponentCode": { "title": "regularAssetTypeTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Component_Code" }, "regularAssetTypeTaskComponentDescription": { "title": "regularAssetTypeTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Component_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" } } }, "GetAssetTypeFmecaTaskCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeFmecaAssetTypeCode": { "title": "assetTypeFmecaAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_AssetType_Code" }, "assetTypeFmecaComponentCode": { "title": "assetTypeFmecaComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_Component_Code" }, "assetTypeFmecaLinkedToEntityType": { "title": "assetTypeFmecaLinkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeTreePathItems": { "title": "regularAssetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTypeTaskComponentTreePathItems": { "title": "regularAssetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetAssetTypeFmecaTaskForAssetTypeFmecaCollectionResourceActionResponse": { "title": "GetAssetTypeFmecaTaskForAssetTypeFmecaCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFmecaTaskForAssetTypeFmecaCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFmecaTaskForAssetTypeFmecaCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->InheritedFrom_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" } } } }, "AssetTypeFmecaTaskAssetTypeFmecaLookupResourceActionResponse": { "title": "AssetTypeFmecaTaskAssetTypeFmecaLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaTaskAssetTypeFmecaLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaTaskAssetTypeFmecaLookupResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->AssetType_Description" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmeca->Component_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeComponentLookupResourceActionLookupResourceActionActionResponse": { "title": "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeComponentLookupResourceActionLookupResourceActionActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeComponentLookupResourceActionLookupResourceActionActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeComponentLookupResourceActionLookupResourceActionActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeLookupResourceActionResponse": { "title": "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaTaskAssetTypeTaskFromAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFmecaTaskChangePermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFmecaTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFmecaTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFmecaTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFmecaTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFmecaTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAssetTypeFmecaTaskResourceActionResponse": { "title": "CreateAssetTypeFmecaTaskResourceActionResponse", "type": "object", "properties": { "properties": { "title": "CreateAssetTypeFmecaTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "required": [ "assetTypeFmecaId", "regularAssetTypeTaskId" ], "properties": { "assetTypeFmecaId": { "title": "assetTypeFmecaId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->AssetTypeFmeca_Id" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->RegularAssetTypeTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFmecaTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAssetTypeFmecaTaskResourceActionResponse": { "title": "UpdateAssetTypeFmecaTaskResourceActionResponse", "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": "AssetTypeFmecaTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFmecaTask->Notes" } ] } } }, "BatchGetAssetTypeFmecaTaskResourceAction": { "title": "BatchGetAssetTypeFmecaTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Type FMECA Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Type FMECA Task entities", "items": { "$ref": "#/definitions/GetAssetTypeFmecaTaskResourceActionResponse" } }, "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" } } }, "BatchCreateAssetTypeFmecaTaskResourceActionRequest": { "title": "BatchCreateAssetTypeFmecaTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetTypeFmecaTaskResourceActionResponse" } }, "BatchUpdateAssetTypeFmecaTaskResourceActionResponse": { "title": "BatchUpdateAssetTypeFmecaTaskResourceActionResponse", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetTypeFmecaTaskResourceActionResponse" } }, "ChangeAssetTypeFmecaTaskIsActiveResourceActionRequest": { "title": "ChangeAssetTypeFmecaTaskIsActiveResourceActionRequest", "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": "AssetTypeFmecaTask->IsActive" } ] } } }, "ChangeAssetTypeFmecaTaskPermissionTreeResourceActionRequest": { "title": "ChangeAssetTypeFmecaTaskPermissionTreeResourceActionRequest", "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": "AssetTypeFmecaTask->PermissionTree_Id" } ] } } }, "BatchChangeAssetTypeFmecaTaskIsActiveResourceActionRequest": { "title": "BatchChangeAssetTypeFmecaTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFmecaTaskIsActiveResourceActionRequest" } }, "BatchChangeAssetTypeFmecaTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetTypeFmecaTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFmecaTaskPermissionTreeResourceActionRequest" } }, "GetAssetTypeFolderResourceActionResponse": { "title": "GetAssetTypeFolderResourceActionResponse", "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": "GetAssetTypeFolderResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFolder->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFolder->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFolder->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->AlternativeDescription" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->Notes" }, "parentAssetTypeFolderId": { "title": "parentAssetTypeFolderId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Id" }, "parentAssetTypeFolderCode": { "title": "parentAssetTypeFolderCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Code" }, "parentAssetTypeFolderDescription": { "title": "parentAssetTypeFolderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "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" } } }, "GetAssetTypeFolderCollectionResourceActionResponse": { "title": "GetAssetTypeFolderCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFolderCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFolderCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->SequenceNumber" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->PermissionTree_Description" }, "parentAssetTypeFolderId": { "title": "parentAssetTypeFolderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Id" }, "parentAssetTypeFolderCode": { "title": "parentAssetTypeFolderCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Code" }, "parentAssetTypeFolderDescription": { "title": "parentAssetTypeFolderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->Notes" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->IsActive" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFolder->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFolder->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFolder->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" } } } }, "AssetTypeFolderChangePermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFolderChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFolderChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFolderChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFolderInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFolderInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFolderInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFolderInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFolderParentFolderLookupResourceActionResponse": { "title": "AssetTypeFolderParentFolderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFolderParentFolderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFolderParentFolderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->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" } } } }, "CreateAssetTypeFolderResourceActionRequest": { "title": "CreateAssetTypeFolderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAssetTypeFolderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "parentAssetTypeFolderId" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFolder->AlternativeDescription", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->Notes" }, "parentAssetTypeFolderId": { "title": "parentAssetTypeFolderId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAssetTypeFolderResourceActionRequest": { "title": "UpdateAssetTypeFolderResourceActionRequest", "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": "AssetTypeFolder->SequenceNumber" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Description" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFolder->AlternativeDescription" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->Notes" } ] } } }, "DeleteAssetTypeFolderResourceActionRequest": { "title": "DeleteAssetTypeFolderResourceActionRequest", "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 } } }, "BatchGetAssetTypeFolderResourceAction": { "title": "BatchGetAssetTypeFolderResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Type Folder entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Type Folder entities", "items": { "$ref": "#/definitions/GetAssetTypeFolderResourceActionResponse" } }, "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" } } }, "BatchCreateAssetTypeFolderResourceActionRequest": { "title": "BatchCreateAssetTypeFolderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetTypeFolderResourceActionRequest" } }, "BatchUpdateAssetTypeFolderResourceActionRequest": { "title": "BatchUpdateAssetTypeFolderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetTypeFolderResourceActionRequest" } }, "BatchDeleteAssetTypeFolderResourceActionRequest": { "title": "BatchDeleteAssetTypeFolderResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAssetTypeFolderResourceActionRequest" } }, "ChangeAssetTypeFolderIsActiveResourceActionRequest": { "title": "ChangeAssetTypeFolderIsActiveResourceActionRequest", "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": "AssetTypeFolder->IsActive" } ] } } }, "ChangeAssetTypeFolderPermissionTreeResourceActionRequest": { "title": "ChangeAssetTypeFolderPermissionTreeResourceActionRequest", "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": "AssetTypeFolder->PermissionTree_Id" } ] } } }, "MoveAssetTypeFolderResourceActionRequest": { "title": "MoveAssetTypeFolderResourceActionRequest", "type": "object", "properties": { "properties": { "title": "MoveAssetTypeFolderResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "sourceId", "targetId", "targetType" ], "properties": { "sourceId": { "title": "sourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MoveEntity->SourceId" }, "targetId": { "title": "targetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MoveEntity->TargetId" }, "targetType": { "title": "targetType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "MoveEntity->TargetType", "x-formatSpecifier": "EntityType" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeAssetTypeFolderIsActiveResourceActionRequest": { "title": "BatchChangeAssetTypeFolderIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFolderIsActiveResourceActionRequest" } }, "BatchChangeAssetTypeFolderPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetTypeFolderPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFolderPermissionTreeResourceActionRequest" } }, "GetAssetTypeFunctionResourceActionResponse": { "title": "GetAssetTypeFunctionResourceActionResponse", "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": "GetAssetTypeFunctionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFunction->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFunction->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFunction->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->PermissionTree_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetType_Code" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetType_Description" }, "assetTypeComponentId": { "title": "assetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetTypeComponent_Id" }, "assetTypeComponentCode": { "title": "assetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetTypeComponent_Code" }, "assetTypeComponentDescription": { "title": "assetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetTypeComponent_Description" }, "assetTypeComponentRecordType": { "title": "assetTypeComponentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetTypeComponent_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->InheritedFrom_Id" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->Notes" } } }, "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" } } }, "GetAssetTypeFunctionCollectionResourceActionResponse": { "title": "GetAssetTypeFunctionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFunctionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFunctionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetType_Code" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFunction->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetTypeComponentCode": { "title": "assetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetTypeComponent_Code" }, "assetTypeComponentTreePathItems": { "title": "assetTypeComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeFunction->AssetTypeComponent_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->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" } } } }, "GetAssetTypeFunctionForRegularAssetTypeCollectionResourceActionResponse": { "title": "GetAssetTypeFunctionForRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFunctionForRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFunctionForRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->InheritedFrom_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" } } } }, "GetAssetTypeFunctionForRegularAssetTypeComponentCollectionResourceActionResponse": { "title": "GetAssetTypeFunctionForRegularAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFunctionForRegularAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFunctionForRegularAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->InheritedFrom_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" } } } }, "GetAssetTypeFunctionForInPlaceAssetTypeCollectionResourceActionResponse": { "title": "GetAssetTypeFunctionForInPlaceAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFunctionForInPlaceAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFunctionForInPlaceAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->InheritedFrom_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" } } } }, "GetAssetTypeFunctionForPlaceholderAssetTypeCollectionResourceActionResponse": { "title": "GetAssetTypeFunctionForPlaceholderAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFunctionForPlaceholderAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFunctionForPlaceholderAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->InheritedFrom_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" } } } }, "GetAssetTypeFunctionForPlaceholderAssetTypeComponentCollectionResourceActionResponse": { "title": "GetAssetTypeFunctionForPlaceholderAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetTypeFunctionForPlaceholderAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetTypeFunctionForPlaceholderAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->InheritedFrom_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" } } } }, "AssetTypeFunctionRegularAssetComponentLookupResourceActionResponse": { "title": "AssetTypeFunctionRegularAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFunctionRegularAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFunctionRegularAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTypeFunctionChangePermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFunctionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFunctionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFunctionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFunctionInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetTypeFunctionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFunctionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFunctionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeFunctionRegularAssetTypeLookupResourceActionResponse": { "title": "AssetTypeFunctionRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeFunctionRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeFunctionRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateAssetTypeFunctionResourceActionResponse": { "title": "CreateAssetTypeFunctionResourceActionResponse", "type": "object", "properties": { "properties": { "title": "CreateAssetTypeFunctionResourceActionResponseProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "assetTypeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->AssetType_Id" }, "assetTypeComponentId": { "title": "assetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->AssetTypeComponent_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetTypeFunction->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAssetTypeFunctionResourceActionResponse": { "title": "UpdateAssetTypeFunctionResourceActionResponse", "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": "AssetTypeFunction->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetTypeFunction->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFunction->Notes" } ] } } }, "BatchGetAssetTypeFunctionResourceAction": { "title": "BatchGetAssetTypeFunctionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Type Function entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Type Function entities", "items": { "$ref": "#/definitions/GetAssetTypeFunctionResourceActionResponse" } }, "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" } } }, "BatchCreateAssetTypeFunctionResourceActionRequest": { "title": "BatchCreateAssetTypeFunctionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetTypeFunctionResourceActionResponse" } }, "BatchUpdateAssetTypeFunctionResourceActionResponse": { "title": "BatchUpdateAssetTypeFunctionResourceActionResponse", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetTypeFunctionResourceActionResponse" } }, "ChangeAssetTypeFunctionIsActiveResourceActionRequest": { "title": "ChangeAssetTypeFunctionIsActiveResourceActionRequest", "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": "AssetTypeFunction->IsActive" } ] } } }, "ChangeAssetTypeFunctionPermissionTreeResourceActionRequest": { "title": "ChangeAssetTypeFunctionPermissionTreeResourceActionRequest", "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": "AssetTypeFunction->PermissionTree_Id" } ] } } }, "BatchChangeAssetTypeFunctionIsActiveResourceActionRequest": { "title": "BatchChangeAssetTypeFunctionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFunctionIsActiveResourceActionRequest" } }, "BatchChangeAssetTypeFunctionPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetTypeFunctionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetTypeFunctionPermissionTreeResourceActionRequest" } }, "GetAssetTypeTreePathMapResourceActionResponse": { "title": "GetAssetTypeTreePathMapResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TreePathMapNode->Id" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "TreePathMapNode->Code" }, "recordType": { "title": "recordType", "type": "string", "x-nullable": true, "x-propertyPath": "TreePathMapNode->RecordType" }, "treeLevel": { "title": "treeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TreePathMapNode->TreeLevel" }, "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TreePathMapNode->Type", "x-formatSpecifier": "EntityType" } } }, "GetAssetTypeTreePathMapResourceAction": { "title": "GetAssetTypeTreePathMapResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Type Tree entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Type Tree entities", "items": { "$ref": "#/definitions/GetAssetTypeTreePathMapResourceActionResponse" } }, "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" } } }, "GetTreeGetAssetTypeChangedEntitiesResourceActionResponse": { "title": "GetTreeGetAssetTypeChangedEntitiesResourceActionResponse", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ChangedEntity->EntityType", "x-formatSpecifier": "EntityType" }, "entityIds": { "title": "entityIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "ChangedEntity->EntityIds", "x-formatSpecifier": "Int64" } } }, "GetTreeGetAssetTypeChangedEntitiesResourceAction": { "title": "GetTreeGetAssetTypeChangedEntitiesResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Type Tree entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Type Tree entities", "items": { "$ref": "#/definitions/GetTreeGetAssetTypeChangedEntitiesResourceActionResponse" } }, "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" } } }, "AssetRegisterTreeNodeSchema": { "type": "object", "required": [ "properties", "childCounts", "links" ], "properties": { "entityType": { "type": "string" }, "id": { "type": "integer", "description": "Id of Resource", "format": "int64" }, "version": { "type": "integer", "description": "Version of Resource", "format": "int32" }, "properties": { "type": "object", "description": "List of properties as a map `{ \"name\" : value, ...}`", "additionalProperties": {} }, "permissionViolations": { "type": "array", "description": "List of permission violations for resource data", "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "childCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "permissionViolationsLookup": { "description": "List of permission violations for resource data", "$ref": "#/definitions/PermissionViolationLookupSchema" }, "messages": { "type": "array", "description": "List of messages for Resource data", "items": { "$ref": "#/definitions/NotificationItemSchema" } }, "translations": { "type": "array", "description": "Translations for resource data", "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "links": { "type": "array", "description": "Hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "description": "Self link to re-execute", "$ref": "#/definitions/Link" } } }, "PermissionViolationLookupSchema": { "type": "object", "properties": { "permissions": { "type": "array", "description": "Lookup table to find more information about the permissions for the violations", "items": { "$ref": "#/definitions/PermissionViolationPermissionLookupSchema" } }, "permissionTrees": { "type": "array", "description": "Lookup table to find more information about the permission trees for the violations", "items": { "$ref": "#/definitions/PermissionViolationTreeCodeLookupSchema" } } } }, "PermissionViolationPermissionLookupSchema": { "type": "object", "required": [ "permissionId", "permissionCategory", "permissionSubcategory", "permissionEntityName", "permissionName" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionCategory": { "type": "string" }, "permissionSubcategory": { "type": "string" }, "permissionEntityName": { "type": "string" }, "permissionName": { "type": "string" } } }, "PermissionViolationTreeCodeLookupSchema": { "type": "object", "required": [ "permissionTreeId", "permissionTreeCode" ], "properties": { "permissionTreeId": { "type": "integer", "format": "int64" }, "permissionTreeCode": { "type": "string" } } }, "GetTreeAssetTypeComponentsRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTypeComponentsRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTypeComponentsRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTypeComponentsRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->PartNumber" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->SupplierPartNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Quantity" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeComponent->Supplier_Description" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->ParentComponent_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_Description" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeComponent->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->IsInherited" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeComponent->RulesLastChangedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeComponent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeComponent->PermissionTree_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" } } } }, "AssetRegisterTreeNodeCollectionPageSchema": { "type": "object", "required": [ "count", "items", "links" ], "properties": { "count": { "type": "integer", "description": "Number of resource items", "format": "int32" }, "self": { "description": "Self link to re-execute", "$ref": "#/definitions/Link" }, "prev": { "description": "Link to previous page of resource data", "$ref": "#/definitions/Link" }, "next": { "description": "Link to next page of resource data", "$ref": "#/definitions/Link" }, "items": { "type": "array", "description": "List of resource items", "items": { "$ref": "#/definitions/AssetRegisterTreeNodeSchema" } }, "messages": { "type": "array", "description": "List of messages for Resource data", "items": { "$ref": "#/definitions/NotificationItemSchema" } }, "links": { "type": "array", "description": "Hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetTreeAssetTypeFolderRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTypeFolderRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTypeFolderRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTypeFolderRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->SequenceNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->PermissionTree_Description" }, "parentAssetTypeFolderId": { "title": "parentAssetTypeFolderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Id" }, "parentAssetTypeFolderCode": { "title": "parentAssetTypeFolderCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Code" }, "parentAssetTypeFolderDescription": { "title": "parentAssetTypeFolderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeFolder->ParentAssetTypeFolder_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeFolder->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFolder->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeFolder->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" } } } }, "GetTreeAssetTypesRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTypesRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTypesRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTypesRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetType->SequenceNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetType->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetType->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetType->IsActive" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->ParentAssetType_Description" }, "parentAssetTypeRecordType": { "title": "parentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->ParentAssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetType->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetType->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" } } } }, "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" } } }, "GetTreeAssetTypeTaskResourcesRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTypeTaskResourcesRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTypeTaskResourcesRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTypeTaskResourcesRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->IsActive" }, "assetTypeTaskId": { "title": "assetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_Id" }, "assetTypeTaskCode": { "title": "assetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_Code" }, "assetTypeTaskDescription": { "title": "assetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_Description" }, "assetTypeTaskRecordType": { "title": "assetTypeTaskRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "assetTypeTaskAssetTypeId": { "title": "assetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_AssetType_Id" }, "assetTypeTaskAssetTypeCode": { "title": "assetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_AssetType_Code" }, "assetTypeTaskAssetTypeDescription": { "title": "assetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_AssetType_Description" }, "assetTypeTaskAssetTypeTreePathItems": { "title": "assetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetTypeTaskComponentId": { "title": "assetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_Component_Id" }, "assetTypeTaskComponentTreePathItems": { "title": "assetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeTaskResource->AssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Resource_ContactDetailLastName" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Resource_Description" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Trade_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->Competency_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->SequenceNumber" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeTaskResource->RulesLastChangedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskResource->PermissionTree_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" } } } }, "GetTreeAssetTypeTaskSparesRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTypeTaskSparesRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTypeTaskSparesRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTypeTaskSparesRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->CostElement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->Quantity" }, "assetTypeTaskId": { "title": "assetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_Id" }, "assetTypeTaskCode": { "title": "assetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_Code" }, "assetTypeTaskDescription": { "title": "assetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_Description" }, "assetTypeTaskRecordType": { "title": "assetTypeTaskRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "assetTypeTaskAssetTypeId": { "title": "assetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_AssetType_Id" }, "assetTypeTaskAssetTypeCode": { "title": "assetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_AssetType_Code" }, "assetTypeTaskAssetTypeDescription": { "title": "assetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_AssetType_Description" }, "assetTypeTaskAssetTypeTreePathItems": { "title": "assetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetTypeTaskComponentId": { "title": "assetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_Component_Id" }, "assetTypeTaskComponentTreePathItems": { "title": "assetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeTaskSpare->AssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeTaskSpare->RulesLastChangedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTaskSpare->PermissionTree_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" } } } }, "GetTreeAssetTypeTasksRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTypeTasksRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTypeTasksRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTypeTasksRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTask->Code" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTask->AlternativeDescription" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeTask->SequenceNumber" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTask->AssetType_Description" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTask->PermissionTree_Description" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeTask->IsInspection" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeTask->IsNonUsageBasedReadingRequired" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTypeTask->IsMandatory" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTask->Importance_Code" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTypeTask->RulesLastChangedOn" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTypeTask->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" } } } }, "GetTreeAuxiliaryAssetTypeTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeAuxiliaryAssetTypeTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAuxiliaryAssetTypeTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAuxiliaryAssetTypeTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AlternativeDescription" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->SequenceNumber" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Description" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_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" } } } }, "GetTreeInPlaceAssetTypeRecursiveCollectionResourceActionResponse": { "title": "GetTreeInPlaceAssetTypeRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeInPlaceAssetTypeRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeInPlaceAssetTypeRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->IsInherited" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Description" }, "parentAssetTypeRecordType": { "title": "parentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetTreePlaceholderAssetTypeComponentRecursiveCollectionResourceActionResponse": { "title": "GetTreePlaceholderAssetTypeComponentRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreePlaceholderAssetTypeComponentRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreePlaceholderAssetTypeComponentRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PartNumber" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SupplierPartNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Quantity" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Description" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Description" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Description" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->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" } } } }, "GetTreePlaceholderAssetTypeRecursiveCollectionResourceActionResponse": { "title": "GetTreePlaceholderAssetTypeRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreePlaceholderAssetTypeRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreePlaceholderAssetTypeRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->SequenceNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Description" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Description" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->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" } } } }, "GetTreeRegularAssetTypeComponentRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeComponentRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeComponentRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeComponentRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PartNumber" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SupplierPartNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Quantity" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Description" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->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" } } } }, "GetTreeRegularAssetTypeRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetType->SequenceNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Description" }, "parentAssetTypeRecordType": { "title": "parentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetType->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" } } } }, "GetTreeRegularAssetTypeTaskAuxiliaryTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskAuxiliaryTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskAuxiliaryTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskAuxiliaryTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Component_Id" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->SequenceNumber" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_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" } } } }, "GetTreeRegularAssetTypeTaskConditionsRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskConditionsRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskConditionsRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskConditionsRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskIntervalType1Id": { "title": "regularAssetTypeTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Id" }, "intervalCode": { "title": "intervalCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Code" }, "intervalDescription": { "title": "intervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->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" } } } }, "GetTreeRegularAssetTypeTaskFollowUpTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskFollowUpTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskFollowUpTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskFollowUpTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeTreePathItems": { "title": "regularAssetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Component_Id" }, "regularAssetTypeTaskComponentTreePathItems": { "title": "regularAssetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->SequenceNumber" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PermissionTree_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" } } } }, "GetTreeRegularAssetTypeTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AlternativeDescription" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SequenceNumber" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInspection" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsNonUsageBasedReadingRequired" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsMandatory" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Importance_Code" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTask->RulesLastChangedOn" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Description" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_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" } } } }, "GetTreeRegularAssetTypeTaskResourceRuleLinksRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskResourceRuleLinksRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskResourceRuleLinksRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskResourceRuleLinksRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskResourceId": { "title": "regularAssetTypeTaskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id" }, "regularAssetTypeTaskResourceResourceId": { "title": "regularAssetTypeTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Id" }, "regularAssetTypeTaskResourceResourceCode": { "title": "regularAssetTypeTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code" }, "regularAssetTypeTaskResourceResourceDescription": { "title": "regularAssetTypeTaskResourceResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Description" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Component_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetTreeRegularAssetTypeTaskSpareRuleLinksRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskSpareRuleLinksRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskSpareRuleLinksRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskSpareRuleLinksRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskSpareId": { "title": "regularAssetTypeTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id" }, "regularAssetTypeTaskSpareMaterialMasterId": { "title": "regularAssetTypeTaskSpareMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Id" }, "regularAssetTypeTaskSpareMaterialMasterCode": { "title": "regularAssetTypeTaskSpareMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Code" }, "regularAssetTypeTaskSpareMaterialMasterDescription": { "title": "regularAssetTypeTaskSpareMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Description" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Component_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetTreeRegularAssetTypeTaskSparesRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskSparesRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskSparesRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskSparesRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Description" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Component_Id" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->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" } } } }, "GetTreeRegularAssetTypeTaskSuppressedTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTypeTaskSuppressedTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTypeTaskSuppressedTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTypeTaskSuppressedTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeTreePathItems": { "title": "regularAssetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Component_Id" }, "regularAssetTypeTaskComponentTreePathItems": { "title": "regularAssetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Description" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetAuxiliaryAssetTypeTaskResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskResourceActionResponse", "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": "GetAuxiliaryAssetTypeTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AlternativeDescription" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeTreePathId": { "title": "assetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_TreePathId" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateTotalDuration" }, "auxiliaryTaskType": { "title": "auxiliaryTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AuxiliaryTaskType", "x-formatSpecifier": "AuxiliaryTaskType" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Description" }, "componentQuantity": { "title": "componentQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Quantity" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentAssetTypeId": { "title": "componentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_AssetType_Id" }, "componentAssetTypeCode": { "title": "componentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_AssetType_Code" }, "componentAssetTypeDescription": { "title": "componentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_AssetType_Description" }, "componentAssetTypeRecordType": { "title": "componentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "componentTreePathId": { "title": "componentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_TreePathId" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Description" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->DurationPerUnit" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->InheritedFrom_Id" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->InheritedFrom_Description" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->IsHistorical" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->IsSuppressed" }, "isSuppressor": { "title": "isSuppressor", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->IsSuppressor" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleSection_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceContactDetailId": { "title": "responsibleStaffMemberResourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailId" }, "responsibleStaffMemberResourceContactDetailFirstName": { "title": "responsibleStaffMemberResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailFirstName" }, "responsibleStaffMemberResourceContactDetailLastName": { "title": "responsibleStaffMemberResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailLastName" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleTrade_Description" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->TotalDuration" } } }, "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" } } }, "GetAuxiliaryAssetTypeTaskCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Description" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Description" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTypeTaskAssetTypeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTypeTaskChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskComponentLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTypeTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResponsibleSectionLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResponsibleSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResponsibleSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResponsibleSectionLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResponsibleTradeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResponsibleTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResponsibleTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResponsibleTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAuxiliaryAssetTypeTaskResourceActionRequest": { "title": "CreateAuxiliaryAssetTypeTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTypeTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetTypeId", "description", "labourDurationCalculationType", "autoCalculateTotalDowntime", "autoCalculateDurationPerUnit", "autoCalculateTotalDuration" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AlternativeDescription", "x-systemGenerated": true }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_Id" }, "auxiliaryTaskType": { "title": "auxiliaryTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AuxiliaryTaskType", "x-formatSpecifier": "AuxiliaryTaskType" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code", "x-systemGenerated": true }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Id" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Description" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->PermissionTree_Id", "x-systemGenerated": true }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleSection_Id" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleTrade_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->SequenceNumber" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateTotalDuration" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->DurationPerUnit" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->TotalDuration" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTypeTaskResourceActionRequest": { "title": "UpdateAuxiliaryAssetTypeTaskResourceActionRequest", "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": "AuxiliaryAssetTypeTask->AlternativeDescription", "x-systemGenerated": true }, { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Component_Id" }, { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->Notes" }, { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleStaffMemberResource_Id" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleSection_Id" }, { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->ResponsibleTrade_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->SequenceNumber" }, { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateDurationPerUnit" }, { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateTotalDowntime" }, { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->AutoCalculateTotalDuration" }, { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->DowntimePerUnit" }, { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->DurationPerUnit" }, { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->TotalDowntime" }, { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTypeTask->TotalDuration" } ] } } }, "BatchGetAuxiliaryAssetTypeTaskResourceAction": { "title": "BatchGetAuxiliaryAssetTypeTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Type Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Type Task entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTypeTaskResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTypeTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTypeTaskResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTypeTaskResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTypeTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskResourceActionRequest" } }, "ChangeAuxiliaryAssetTypeTaskIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskIsActiveResourceActionRequest", "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": "AuxiliaryAssetTypeTask->IsActive" } ] } } }, "ChangeAuxiliaryAssetTypeTaskPermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskPermissionTreeResourceActionRequest", "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": "AuxiliaryAssetTypeTask->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTypeTaskIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTypeTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskPermissionTreeResourceActionRequest" } }, "GetAuxiliaryAssetTypeTaskResourceResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskResourceResourceActionResponse", "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": "GetAuxiliaryAssetTypeTaskResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id" }, "auxiliaryAssetTypeTaskCode": { "title": "auxiliaryAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Code" }, "auxiliaryAssetTypeTaskDescription": { "title": "auxiliaryAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskResource->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->PermissionTree_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Description" }, "unitOfMeasurementMeasurementType": { "title": "unitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTypeTaskResource->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" } } }, "GetAuxiliaryAssetTypeTaskResourceCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskResourceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTypeTaskResourceCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTypeTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id" }, "auxiliaryAssetTypeTaskCode": { "title": "auxiliaryAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Code" }, "auxiliaryAssetTypeTaskDescription": { "title": "auxiliaryAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->SequenceNumber" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Description" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->IsInherited" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Notes" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->IsActive" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->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" } } } }, "GetResourceForAuxiliaryAssetTypeTaskCollectionResourceActionResponse": { "title": "GetResourceForAuxiliaryAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetResourceForAuxiliaryAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetResourceForAuxiliaryAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Description" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Description" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->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" } } } }, "AuxiliaryAssetTypeTaskResourceTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceTaskAuxiliaryAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceTaskAuxiliaryAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->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" } } } }, "AuxiliaryAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResourceCompetencyLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceCompetencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceCompetencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceCompetencyLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResourceResourceLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTypeTaskResourceSectionLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceSectionLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResourceTradeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceTradeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAuxiliaryAssetTypeTaskResourceResourceActionRequest": { "title": "CreateAuxiliaryAssetTypeTaskResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTypeTaskResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "auxiliaryAssetTypeTaskId", "quantity", "tradeId" ], "properties": { "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Id" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Usage", "x-systemGenerated": true, "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->PermissionTree_Id", "x-systemGenerated": true }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Id" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->ResourceType", "x-systemGenerated": true, "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTypeTaskResourceResourceActionRequest": { "title": "UpdateAuxiliaryAssetTypeTaskResourceResourceActionRequest", "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": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->AuxiliaryAssetTypeTask_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Notes" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Resource_Id" }, { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Competency_Id" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Proficiency" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->Quantity" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskResource->UnitOfMeasurement_Id" } ] } } }, "BatchGetAuxiliaryAssetTypeTaskResourceResourceAction": { "title": "BatchGetAuxiliaryAssetTypeTaskResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Type Task Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Type Task Resource entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskResourceResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTypeTaskResourceResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTypeTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTypeTaskResourceResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTypeTaskResourceResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTypeTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskResourceResourceActionRequest" } }, "ChangeAuxiliaryAssetTypeTaskResourceIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskResourceIsActiveResourceActionRequest", "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": "AuxiliaryAssetTypeTaskResource->IsActive" } ] } } }, "ChangeAuxiliaryAssetTypeTaskResourcePermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskResourcePermissionTreeResourceActionRequest", "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": "AuxiliaryAssetTypeTaskResource->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTypeTaskResourceIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskResourceIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTypeTaskResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskResourcePermissionTreeResourceActionRequest" } }, "GetAuxiliaryAssetTypeTaskSpareResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskSpareResourceActionResponse", "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": "GetAuxiliaryAssetTypeTaskSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id" }, "auxiliaryAssetTypeTaskCode": { "title": "auxiliaryAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Code" }, "auxiliaryAssetTypeTaskDescription": { "title": "auxiliaryAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PermissionTree_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->InheritedFrom_Id" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->IsHistorical" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->Notes" }, "preferredMaterialMasterId": { "title": "preferredMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Id" }, "preferredMaterialMasterCode": { "title": "preferredMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Code" }, "preferredMaterialMasterDescription": { "title": "preferredMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PreferredMaterialMaster_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" } } }, "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" } } }, "GetAuxiliaryAssetTypeTaskSpareCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTypeTaskSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTypeTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Description" }, "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id" }, "auxiliaryAssetTypeTaskCode": { "title": "auxiliaryAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Code" }, "auxiliaryAssetTypeTaskDescription": { "title": "auxiliaryAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Description" }, "auxiliaryAssetTypeTaskAssetTypeTreePathItems": { "title": "auxiliaryAssetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "auxiliaryAssetTypeTaskComponentTreePathItems": { "title": "auxiliaryAssetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->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" } } } }, "GetSpareForAuxiliaryAssetTypeTaskCollectionResourceActionResponse": { "title": "GetSpareForAuxiliaryAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForAuxiliaryAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForAuxiliaryAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->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" } } } }, "AuxiliaryAssetTypeTaskSpareTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSpareTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSpareTaskAuxiliaryAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSpareTaskAuxiliaryAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->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" } } } }, "AuxiliaryAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskSpareCostElementLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSpareCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSpareCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSpareCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskSpareMaterialMasterLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" }, "commodityId": { "title": "commodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MaterialMaster->Commodity_Id" }, "commodityCode": { "title": "commodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Code" }, "commodityDescription": { "title": "commodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->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" } } } }, "CreateAuxiliaryAssetTypeTaskSpareResourceActionRequest": { "title": "CreateAuxiliaryAssetTypeTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTypeTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "auxiliaryAssetTypeTaskId", "materialMasterId" ], "properties": { "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->AuxiliaryAssetTypeTask_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->MaterialMaster_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->PermissionTree_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->CostElement_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->Quantity" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTypeTaskSpareResourceActionRequest": { "title": "UpdateAuxiliaryAssetTypeTaskSpareResourceActionRequest", "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": "AuxiliaryAssetTypeTaskSpare->CostElement_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->Notes" }, { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->Quantity" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSpare->SequenceNumber" } ] } } }, "BatchGetAuxiliaryAssetTypeTaskSpareResourceAction": { "title": "BatchGetAuxiliaryAssetTypeTaskSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Type Task Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Type Task Spare entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskSpareResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTypeTaskSpareResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTypeTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTypeTaskSpareResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTypeTaskSpareResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTypeTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskSpareResourceActionRequest" } }, "ChangeAuxiliaryAssetTypeTaskSpareIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskSpareIsActiveResourceActionRequest", "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": "AuxiliaryAssetTypeTaskSpare->IsActive" } ] } } }, "ChangeAuxiliaryAssetTypeTaskSparePermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskSparePermissionTreeResourceActionRequest", "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": "AuxiliaryAssetTypeTaskSpare->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTypeTaskSpareIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSpareIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTypeTaskSparePermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSparePermissionTreeResourceActionRequest" } }, "GetAuxiliaryAssetTypeTaskSubTaskResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskSubTaskResourceActionResponse", "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": "GetAuxiliaryAssetTypeTaskSubTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Id" }, "auxiliaryAssetTypeTaskCode": { "title": "auxiliaryAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Code" }, "auxiliaryAssetTypeTaskDescription": { "title": "auxiliaryAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->PermissionTree_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AlternativeDescription" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Id" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" } } }, "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" } } }, "GetAuxiliaryAssetTypeTaskSubTaskCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTypeTaskSubTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTypeTaskSubTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTypeTaskSubTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "auxiliaryAssetTypeTaskCode": { "title": "auxiliaryAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Code" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AlternativeDescription" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetSubTaskForAuxiliaryAssetTypeTaskCollectionResourceActionResponse": { "title": "GetSubTaskForAuxiliaryAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSubTaskForAuxiliaryAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSubTaskForAuxiliaryAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AlternativeDescription" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTypeTaskSubTaskTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSubTaskTaskAuxiliaryAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSubTaskTaskAuxiliaryAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSubTaskTaskAuxiliaryAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->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" } } } }, "AuxiliaryAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest": { "title": "CreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "auxiliaryAssetTypeTaskId", "description" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AlternativeDescription", "x-systemGenerated": true }, "auxiliaryAssetTypeTaskId": { "title": "auxiliaryAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AuxiliaryAssetTypeTask_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest": { "title": "UpdateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest", "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": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Code" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Description" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->AlternativeDescription" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTaskSubTask->SequenceNumber" } ] } } }, "BatchGetAuxiliaryAssetTypeTaskSubTaskResourceAction": { "title": "BatchGetAuxiliaryAssetTypeTaskSubTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Type Task Sub Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Type Task Sub Task entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTypeTaskSubTaskResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTypeTaskSubTaskResourceActionRequest" } }, "ChangeAuxiliaryAssetTypeTaskSubTaskIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskSubTaskIsActiveResourceActionRequest", "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": "AuxiliaryAssetTypeTaskSubTask->IsActive" } ] } } }, "ChangeAuxiliaryAssetTypeTaskSubTaskPermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTypeTaskSubTaskPermissionTreeResourceActionRequest", "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": "AuxiliaryAssetTypeTaskSubTask->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTypeTaskSubTaskIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskSubTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSubTaskIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTypeTaskSubTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTypeTaskSubTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTypeTaskSubTaskPermissionTreeResourceActionRequest" } }, "GetInPlaceAssetTypeResourceActionResponse": { "title": "GetInPlaceAssetTypeResourceActionResponse", "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": "GetInPlaceAssetTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetType->LastConfirmedOn" }, "nearestRegularAssetTypeId": { "title": "nearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->NearestRegularAssetType_Id" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Description" }, "parentAssetTypeRecordType": { "title": "parentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->SequenceNumber" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetType->RulesLastChangedOn" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "InPlaceAssetType->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->AssetImportance_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->InheritedFrom_Id" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->InheritedFrom_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->TaskRollUpPoint_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" } } }, "GetInPlaceAssetTypeCollectionResourceActionResponse": { "title": "GetInPlaceAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Description" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetType->RulesLastChangedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->Notes" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->IsActive" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetType->ModifiedOn" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->IsInherited" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "InPlaceAssetType->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetTypeAssetImportanceLookupResourceActionResponse": { "title": "InPlaceAssetTypeAssetImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeAssetImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeAssetImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->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" } } } }, "InPlaceAssetTypeParentLookupResourceActionResponse": { "title": "InPlaceAssetTypeParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeParentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetTypeChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceRegularAssetTypeTaskRollUpPointLookupResourceActionResponse": { "title": "InPlaceRegularAssetTypeTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceRegularAssetTypeTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceRegularAssetTypeTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetTypeResourceActionRequest": { "title": "CreateInPlaceAssetTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "description", "parentAssetTypeId" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAssetType->AlternativeDescription", "x-systemGenerated": true }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->AssetImportance_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAssetType->TaskRollUpPoint_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->Notes" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetType->ParentAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetTypeResourceActionRequest": { "title": "UpdateInPlaceAssetTypeResourceActionRequest", "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": "InPlaceAssetType->SequenceNumber" }, { "title": "code", "type": "string", "readOnly": true, "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code", "x-ReadOnlyExpression": "InPlaceAssetType->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Description", "x-ReadOnlyExpression": "InPlaceAssetType->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAssetType->AlternativeDescription" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAssetType->TaskRollUpPoint_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->Notes" } ] } } }, "BatchGetInPlaceAssetTypeResourceAction": { "title": "BatchGetInPlaceAssetTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Type entities", "items": { "$ref": "#/definitions/GetInPlaceAssetTypeResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetTypeResourceActionRequest": { "title": "BatchCreateInPlaceAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetTypeResourceActionRequest" } }, "BatchUpdateInPlaceAssetTypeResourceActionRequest": { "title": "BatchUpdateInPlaceAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetTypeResourceActionRequest" } }, "ChangeInPlaceAssetTypeIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetTypeIsActiveResourceActionRequest", "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": "InPlaceAssetType->IsActive" } ] } } }, "ChangeInPlaceAssetTypePermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetTypePermissionTreeResourceActionRequest", "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": "InPlaceAssetType->PermissionTree_Id" } ] } } }, "BatchChangeInPlaceAssetTypeIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetTypePermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypePermissionTreeResourceActionRequest" } }, "EntityMatchRecordSchema": { "type": "object", "required": [ "id", "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch.", "format": "int64", "example": 14324399978 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 } } }, "MatchUpdateInPlaceAssetTypeResourceActionRequest": { "title": "MatchUpdateInPlaceAssetTypeResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAssetType->TaskRollUpPoint_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetType->AssetImportance_Id" } ] } } }, "GetInPlaceAssetTypeAttributeResourceActionResponse": { "title": "GetInPlaceAssetTypeAttributeResourceActionResponse", "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": "GetInPlaceAssetTypeAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->InPlaceAssetType_Id" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->InPlaceAssetType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->IsBackup" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeAttribute->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetInPlaceAssetTypeAttributeCollectionForInPlaceAssetTypeResourceActionResponse": { "title": "GetInPlaceAssetTypeAttributeCollectionForInPlaceAssetTypeResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetTypeAttributeCollectionForInPlaceAssetTypeResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetTypeAttributeCollectionForInPlaceAssetTypeResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeAttribute->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" } } } }, "GetInPlaceAssetTypeAttributeCollectionResourceActionResponse": { "title": "GetInPlaceAssetTypeAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetTypeAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetTypeAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->IsInherited" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->InPlaceAssetType_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeAttribute->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" } } } }, "InPlaceAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "InPlaceAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetTypeAttributeAttributeLookupResourceActionResponse": { "title": "InPlaceAssetTypeAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetTypeAttributeRegularAssetTypeTaskLookupResourceActionResponse": { "title": "InPlaceAssetTypeAttributeRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeAttributeRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeAttributeRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->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" } } } }, "InPlaceAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetTypeAttributeResourceActionRequest": { "title": "CreateInPlaceAssetTypeAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetTypeAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetTypeId", "attributeId" ], "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->InPlaceAssetType_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetTypeAttributeResourceActionRequest": { "title": "UpdateInPlaceAssetTypeAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeAttribute->Notes" } ] } } }, "BatchGetInPlaceAssetTypeAttributeResourceAction": { "title": "BatchGetInPlaceAssetTypeAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Type Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Type Attribute entities", "items": { "$ref": "#/definitions/GetInPlaceAssetTypeAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetTypeAttributeResourceActionRequest": { "title": "BatchCreateInPlaceAssetTypeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetTypeAttributeResourceActionRequest" } }, "BatchUpdateInPlaceAssetTypeAttributeResourceActionRequest": { "title": "BatchUpdateInPlaceAssetTypeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetTypeAttributeResourceActionRequest" } }, "ChangeInPlaceAssetTypeAttributeIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetTypeAttributeIsActiveResourceActionRequest", "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": "InPlaceAssetTypeAttribute->IsActive" } ] } } }, "ChangeInPlaceAssetTypeAttributePermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetTypeAttributePermissionTreeResourceActionRequest", "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": "InPlaceAssetTypeAttribute->PermissionTree_Id" } ] } } }, "BatchChangeInPlaceAssetTypeAttributeIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeAttributeIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetTypeAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeAttributePermissionTreeResourceActionRequest" } }, "GetInPlaceAssetTypeResponsibilityResourceActionResponse": { "title": "GetInPlaceAssetTypeResponsibilityResourceActionResponse", "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": "GetInPlaceAssetTypeResponsibilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->InPlaceAssetType_Id" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->InPlaceAssetType_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeResponsibility->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeResponsibility->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeResponsibility->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->InheritedFrom_Id" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->LastConfirmedChangeLogId" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Id", "x-NullExpression": "InPlaceAssetTypeResponsibility->Section_Id eq NULL AND InPlaceAssetTypeResponsibility->Trade_Id eq NULL" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_ContactDetailLastName" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_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" } } }, "GetInPlaceAssetTypeResponsibilityCollectionResourceActionResponse": { "title": "GetInPlaceAssetTypeResponsibilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetTypeResponsibilityCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetTypeResponsibilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->InPlaceAssetType_Id" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->InPlaceAssetType_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->SequenceNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeResponsibility->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeResponsibility->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" } } } }, "GetInPlaceAssetTypeResponsibilityForInPlaceAssetTypeCollectionResourceActionResponse": { "title": "GetInPlaceAssetTypeResponsibilityForInPlaceAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetTypeResponsibilityForInPlaceAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetTypeResponsibilityForInPlaceAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_ContactDetailLastName" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->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" } } } }, "InPlaceAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetTypeResponsibilityInPlaceAssetTypeLookupResourceActionResponse": { "title": "InPlaceAssetTypeResponsibilityInPlaceAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeResponsibilityInPlaceAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeResponsibilityInPlaceAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->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" } } } }, "InPlaceAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetTypeResponsibilityResourceLookupResourceActionResponse": { "title": "InPlaceAssetTypeResponsibilityResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeResponsibilityResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeResponsibilityResourceLookupResourceActionResponseItemProperties", "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" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Section_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" } } } }, "InPlaceAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse": { "title": "InPlaceAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponseItemProperties", "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" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Resource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Section_Code" }, "idResourceTradeResourceTradeCode": { "title": "idResourceTradeResourceTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->*Id.ResourceTrade.Resource_Trade_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" } } } }, "InPlaceAssetTypeResponsibilitySectionLookupResourceActionResponse": { "title": "InPlaceAssetTypeResponsibilitySectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeResponsibilitySectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeResponsibilitySectionLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetTypeResponsibilityTradeLookupResourceActionResponse": { "title": "InPlaceAssetTypeResponsibilityTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeResponsibilityTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeResponsibilityTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetTypeResponsibilityResourceActionRequest": { "title": "CreateInPlaceAssetTypeResponsibilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetTypeResponsibilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetTypeId" ], "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->InPlaceAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Id", "x-NullExpression": "InPlaceAssetTypeResponsibility->Section_Id eq NULL AND InPlaceAssetTypeResponsibility->Trade_Id eq NULL" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetTypeResponsibilityResourceActionRequest": { "title": "UpdateInPlaceAssetTypeResponsibilityResourceActionRequest", "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": "InPlaceAssetTypeResponsibility->SequenceNumber" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeResponsibility->Resource_Id", "x-NullExpression": "InPlaceAssetTypeResponsibility->Section_Id eq NULL AND InPlaceAssetTypeResponsibility->Trade_Id eq NULL" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeResponsibility->Notes" } ] } } }, "BatchGetInPlaceAssetTypeResponsibilityResourceAction": { "title": "BatchGetInPlaceAssetTypeResponsibilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Type Responsibility entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Type Responsibility entities", "items": { "$ref": "#/definitions/GetInPlaceAssetTypeResponsibilityResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetTypeResponsibilityResourceActionRequest": { "title": "BatchCreateInPlaceAssetTypeResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetTypeResponsibilityResourceActionRequest" } }, "BatchUpdateInPlaceAssetTypeResponsibilityResourceActionRequest": { "title": "BatchUpdateInPlaceAssetTypeResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetTypeResponsibilityResourceActionRequest" } }, "ChangeInPlaceAssetTypeResponsibilityIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetTypeResponsibilityIsActiveResourceActionRequest", "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": "InPlaceAssetTypeResponsibility->IsActive" } ] } } }, "ChangeInPlaceAssetTypeResponsibilityPermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetTypeResponsibilityPermissionTreeResourceActionRequest", "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": "InPlaceAssetTypeResponsibility->PermissionTree_Id" } ] } } }, "BatchChangeInPlaceAssetTypeResponsibilityIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeResponsibilityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeResponsibilityIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetTypeResponsibilityPermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeResponsibilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, "GetInPlaceAssetTypeRuleLinkResourceActionResponse": { "title": "GetInPlaceAssetTypeRuleLinkResourceActionResponse", "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": "GetInPlaceAssetTypeRuleLinkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->InPlaceAssetType_Id" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InPlaceAssetType_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeRuleLink->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeRuleLink->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeRuleLink->ModifiedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Id" }, "inheritedFromInPlaceAssetTypeId": { "title": "inheritedFromInPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Id" }, "inheritedFromInPlaceAssetTypeCode": { "title": "inheritedFromInPlaceAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Code" }, "inheritedFromInPlaceAssetTypeDescription": { "title": "inheritedFromInPlaceAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_InPlaceAssetType_Description" }, "inheritedFromRuleId": { "title": "inheritedFromRuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Id" }, "inheritedFromRuleCode": { "title": "inheritedFromRuleCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Code" }, "inheritedFromRuleDescription": { "title": "inheritedFromRuleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Rule_Description" }, "inheritedFromRuleRuleText": { "title": "inheritedFromRuleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleText" }, "inheritedFromRuleRuleCategoryId": { "title": "inheritedFromRuleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Id" }, "inheritedFromRuleRuleCategoryCode": { "title": "inheritedFromRuleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Code" }, "inheritedFromRuleRuleCategoryDescription": { "title": "inheritedFromRuleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Notes" } } }, "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" } } }, "GetInPlaceAssetTypeRuleLinkCollectionResourceActionResponse": { "title": "GetInPlaceAssetTypeRuleLinkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetTypeRuleLinkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetTypeRuleLinkCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InPlaceAssetType_Id" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->InPlaceAssetType_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->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" } } } }, "GetRuleLinkForInPlaceAssetTypeCollectionResourceActionResponse": { "title": "GetRuleLinkForInPlaceAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleLinkForInPlaceAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleLinkForInPlaceAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetTypeRuleLinkTaskInPlaceAssetTypeLookupResourceActionResponse": { "title": "InPlaceAssetTypeRuleLinkTaskInPlaceAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeRuleLinkTaskInPlaceAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeRuleLinkTaskInPlaceAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->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" } } } }, "InPlaceAssetTypeRuleLinkRuleLookupResourceActionResponse": { "title": "InPlaceAssetTypeRuleLinkRuleLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeRuleLinkRuleLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeRuleLinkRuleLookupResourceActionResponseItemProperties", "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" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateInPlaceAssetTypeRuleLinkResourceActionRequest": { "title": "CreateInPlaceAssetTypeRuleLinkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetTypeRuleLinkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetTypeId", "ruleId" ], "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->InPlaceAssetType_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeRuleLink->Rule_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetTypeRuleLinkResourceActionRequest": { "title": "UpdateInPlaceAssetTypeRuleLinkResourceActionRequest", "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": "InPlaceAssetTypeRuleLink->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeRuleLink->SequenceNumber" } ] } } }, "BatchGetInPlaceAssetTypeRuleLinkResourceAction": { "title": "BatchGetInPlaceAssetTypeRuleLinkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Type Rule Link entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Type Rule Link entities", "items": { "$ref": "#/definitions/GetInPlaceAssetTypeRuleLinkResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetTypeRuleLinkResourceActionRequest": { "title": "BatchCreateInPlaceAssetTypeRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetTypeRuleLinkResourceActionRequest" } }, "BatchUpdateInPlaceAssetTypeRuleLinkResourceActionRequest": { "title": "BatchUpdateInPlaceAssetTypeRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetTypeRuleLinkResourceActionRequest" } }, "ChangeInPlaceAssetTypeRuleLinkIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetTypeRuleLinkIsActiveResourceActionRequest", "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": "InPlaceAssetTypeRuleLink->IsActive" } ] } } }, "BatchChangeInPlaceAssetTypeRuleLinkIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeRuleLinkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeRuleLinkIsActiveResourceActionRequest" } }, "GetInPlaceAssetTypeSpareResourceActionResponse": { "title": "GetInPlaceAssetTypeSpareResourceActionResponse", "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": "GetInPlaceAssetTypeSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->InPlaceAssetType_Id" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->InPlaceAssetType_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeSpare->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetTypeSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->InheritedFrom_Id" }, "inheritedFromMaterialMasterId": { "title": "inheritedFromMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Id" }, "inheritedFromMaterialMasterCode": { "title": "inheritedFromMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Code" }, "inheritedFromMaterialMasterDescription": { "title": "inheritedFromMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->InheritedFrom_MaterialMaster_Description" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsEmergency" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "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" } } }, "GetInPlaceAssetTypeSpareCollectionResourceActionResponse": { "title": "GetInPlaceAssetTypeSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetTypeSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetTypeSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->InPlaceAssetType_Id" }, "inPlaceAssetTypeCode": { "title": "inPlaceAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->InPlaceAssetType_Code" }, "inPlaceAssetTypeDescription": { "title": "inPlaceAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->InPlaceAssetType_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetSpareForInPlaceAssetTypeCollectionResourceActionResponse": { "title": "GetSpareForInPlaceAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForInPlaceAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForInPlaceAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsEmergency" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsInherited" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsCritical" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetTypeSpareChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetTypeSpareInPlaceAssetTypeLookupResourceActionResponse": { "title": "InPlaceAssetTypeSpareInPlaceAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeSpareInPlaceAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeSpareInPlaceAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetType->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" } } } }, "InPlaceAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetTypeSpareMaterialMasterLookupResourceActionResponse": { "title": "InPlaceAssetTypeSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetTypeSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetTypeSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetTypeSpareResourceActionRequest": { "title": "CreateInPlaceAssetTypeSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetTypeSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetTypeId", "materialMasterId", "isCritical", "isEmergency" ], "properties": { "inPlaceAssetTypeId": { "title": "inPlaceAssetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAssetTypeSpare->InPlaceAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->PermissionTree_Id", "x-systemGenerated": true }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->MaterialMaster_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->SequenceNumber" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsEmergency" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetTypeSpareResourceActionRequest": { "title": "UpdateInPlaceAssetTypeSpareResourceActionRequest", "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": "InPlaceAssetTypeSpare->SequenceNumber" }, { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsCritical" }, { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetTypeSpare->IsEmergency" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetTypeSpare->Notes" } ] } } }, "BatchGetInPlaceAssetTypeSpareResourceAction": { "title": "BatchGetInPlaceAssetTypeSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Type Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Type Spare entities", "items": { "$ref": "#/definitions/GetInPlaceAssetTypeSpareResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetTypeSpareResourceActionRequest": { "title": "BatchCreateInPlaceAssetTypeSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetTypeSpareResourceActionRequest" } }, "BatchUpdateInPlaceAssetTypeSpareResourceActionRequest": { "title": "BatchUpdateInPlaceAssetTypeSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetTypeSpareResourceActionRequest" } }, "ChangeInPlaceAssetTypeSpareIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetTypeSpareIsActiveResourceActionRequest", "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": "InPlaceAssetTypeSpare->IsActive" } ] } } }, "ChangeInPlaceAssetTypeSparePermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetTypeSparePermissionTreeResourceActionRequest", "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": "InPlaceAssetTypeSpare->PermissionTree_Id" } ] } } }, "BatchChangeInPlaceAssetTypeSpareIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeSpareIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetTypeSparePermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetTypeSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetTypeSparePermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeResourceActionResponse": { "title": "GetPlaceholderAssetTypeResourceActionResponse", "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": "GetPlaceholderAssetTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->LastConfirmedOn" }, "nearestRegularAssetTypeId": { "title": "nearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->NearestRegularAssetType_Id" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Description" }, "parentAssetTypeRecordType": { "title": "parentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->SequenceNumber" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->RulesLastChangedOn" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetType->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->AssetImportance_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->InheritedFrom_Id" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Id", "x-NullExpression": "PlaceholderAssetType->RecordType eq 'LinkedPlaceholder'" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->Notes" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->TaskRollUpPoint_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" } } }, "GetPlaceholderAssetTypeCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PlaceholderForAssetType_Description" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Description" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Description" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->RulesLastChangedOn" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PermissionTree_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->IsActive" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetType->ModifiedOn" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetType->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeAssetImportanceLookupResourceActionResponse": { "title": "PlaceholderAssetTypeAssetImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeAssetImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeAssetImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->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" } } } }, "PlaceholderAssetTypeAssetTypeParentLookupResourceActionResponse": { "title": "PlaceholderAssetTypeAssetTypeParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeAssetTypeParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeAssetTypeParentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeLinkedAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeLinkedAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeLinkedAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeLinkedAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeRegularAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderRegularAssetTypeTaskRollUpPointLookupResourceActionResponse": { "title": "PlaceholderRegularAssetTypeTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderRegularAssetTypeTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderRegularAssetTypeTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePlaceholderAssetTypeResourceActionRequest": { "title": "CreatePlaceholderAssetTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "description", "parentAssetTypeId" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->AlternativeDescription", "x-systemGenerated": true }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->AssetImportance_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetType->TaskRollUpPoint_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->PermissionTree_Id", "x-systemGenerated": true }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->ParentAssetType_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeResourceActionRequest", "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": "PlaceholderAssetType->SequenceNumber" }, { "title": "code", "type": "string", "readOnly": true, "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code", "x-ReadOnlyExpression": "PlaceholderAssetType->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Description", "x-ReadOnlyExpression": "PlaceholderAssetType->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->AlternativeDescription" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetType->TaskRollUpPoint_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeResourceAction": { "title": "BatchGetPlaceholderAssetTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeResourceActionRequest" } }, "ChangePlaceholderAssetTypeIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeIsActiveResourceActionRequest", "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": "PlaceholderAssetType->IsActive" } ] } } }, "ChangePlaceholderAssetTypePermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypePermissionTreeResourceActionRequest", "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": "PlaceholderAssetType->PermissionTree_Id" } ] } } }, "ClearPlaceholderAssetTypeResourceActionRequest": { "title": "ClearPlaceholderAssetTypeResourceActionRequest", "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" } } } }, "PlaceholderAssetTypeLinkAssetTypeResourceActionRequest": { "title": "PlaceholderAssetTypeLinkAssetTypeResourceActionRequest", "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": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LinkAssetTypeEntity->LinkedToAssetType_Id" } ] } } }, "SetPlaceholderAssetTypeResourceActionRequest": { "title": "SetPlaceholderAssetTypeResourceActionRequest", "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": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SetPlaceholderAssetTypeEntity->PlaceholderForAssetType_Id" } ] } } }, "BatchChangePlaceholderAssetTypeIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypePermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypePermissionTreeResourceActionRequest" } }, "BatchClearPlaceholderAssetTypeResourceActionRequest": { "title": "BatchClearPlaceholderAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ClearPlaceholderAssetTypeResourceActionRequest" } }, "BatchLinkAssetTypeResourceActionRequest": { "title": "BatchLinkAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/PlaceholderAssetTypeLinkAssetTypeResourceActionRequest" } }, "BatchSetPlaceholderAssetTypeResourceActionRequest": { "title": "BatchSetPlaceholderAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/SetPlaceholderAssetTypeResourceActionRequest" } }, "MatchUpdatePlaceholderAssetTypeResourceActionRequest": { "title": "MatchUpdatePlaceholderAssetTypeResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetType->TaskRollUpPoint_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->AssetImportance_Id" } ] } } }, "GetPlaceholderAssetTypeAttributeResourceActionResponse": { "title": "GetPlaceholderAssetTypeAttributeResourceActionResponse", "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": "GetPlaceholderAssetTypeAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PlaceholderAssetType_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->InheritedFrom" }, "inheritedFromRegularAssetTypeAttribute": { "title": "inheritedFromRegularAssetTypeAttribute", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->InheritedFromRegularAssetTypeAttribute" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->IsBackup" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeAttribute->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetPlaceholderAssetTypeAttributeCollectionForPlaceholderAssetTypeResourceActionResponse": { "title": "GetPlaceholderAssetTypeAttributeCollectionForPlaceholderAssetTypeResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeAttributeCollectionForPlaceholderAssetTypeResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeAttributeCollectionForPlaceholderAssetTypeResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeAttribute->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" } } } }, "GetPlaceholderAssetTypeAttributeCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->IsInherited" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->PlaceholderAssetType_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeAttribute->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" } } } }, "PlaceholderAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "PlaceholderAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeAttributeAttributeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeAttributePlaceholderAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeAttributePlaceholderAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeAttributePlaceholderAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeAttributePlaceholderAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->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" } } } }, "CreatePlaceholderAssetTypeAttributeResourceActionRequest": { "title": "CreatePlaceholderAssetTypeAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeId", "attributeId" ], "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->PlaceholderAssetType_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeAttributeResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeAttribute->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeAttributeResourceAction": { "title": "BatchGetPlaceholderAssetTypeAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Attribute entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeAttributeResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeAttributeResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeAttributeResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeAttributeResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeAttributeResourceActionRequest" } }, "ChangePlaceholderAssetTypeAttributeIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeAttributeIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeAttribute->IsActive" } ] } } }, "ChangePlaceholderAssetTypeAttributePermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeAttributePermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeAttribute->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeAttributeIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeAttributeIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeAttributePermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeAttributePermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeComponentResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentResourceActionResponse", "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": "GetPlaceholderAssetTypeComponentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeNearestRegularAssetTypeId": { "title": "assetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Id" }, "assetTypeNearestRegularAssetTypeCode": { "title": "assetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Code" }, "assetTypeNearestRegularAssetTypeDescription": { "title": "assetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Description" }, "assetTypeTreePathId": { "title": "assetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_TreePathId" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->LastConfirmedOn" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Description" }, "parentComponentTreePathId": { "title": "parentComponentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_TreePathId" }, "parentComponentTreePathItems": { "title": "parentComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SequenceNumber" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->RulesLastChangedOn" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->InheritedFrom_Id" }, "inheritedFromTreePathId": { "title": "inheritedFromTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->InheritedFrom_TreePathId" }, "inheritedFromTreePathItems": { "title": "inheritedFromTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->InheritedFrom_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->IsHistorical" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Description" }, "linkedToAssetTypeTreePathId": { "title": "linkedToAssetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_TreePathId" }, "linkedToAssetTypeTreePathItems": { "title": "linkedToAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Notes" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PartNumber" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Description" }, "placeholderForAssetTypeTreePathId": { "title": "placeholderForAssetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_TreePathId" }, "placeholderForAssetTypeTreePathItems": { "title": "placeholderForAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "specification": { "title": "specification", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Specification" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Description" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SupplierPartNumber" } } }, "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" } } }, "GetPlaceholderAssetTypeComponentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PartNumber" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SupplierPartNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Quantity" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Description" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->PlaceholderForAssetType_Description" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->LinkedToAssetType_Description" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->IsInherited" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Description" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->RulesLastChangedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponent->ModifiedOn" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetTypeComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentImportanceLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->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" } } } }, "PlaceholderAssetTypeComponentInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentLinkedAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentLinkedAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentLinkedAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentLinkedAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentsMaterialMasterLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentsMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentsMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentsMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentParentComponentLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentParentComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentParentComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentParentComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentRegularAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentSupplierLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePlaceholderAssetTypeComponentResourceActionRequest": { "title": "CreatePlaceholderAssetTypeComponentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeComponentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetTypeId", "description", "quantity" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AlternativeDescription", "x-systemGenerated": true }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Id" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Notes" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->MaterialMaster_Id" }, "partNumber": { "title": "partNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PartNumber" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->PermissionTree_Id", "x-systemGenerated": true }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Quantity" }, "specification": { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Specification" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Id" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SupplierPartNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeComponentResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "readOnly": true, "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code", "x-ReadOnlyExpression": "PlaceholderAssetTypeComponent->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Description", "x-ReadOnlyExpression": "PlaceholderAssetTypeComponent->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AlternativeDescription" }, { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Quantity" }, { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Specification" }, { "title": "partNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->PartNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SequenceNumber" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->MaterialMaster_Id" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Supplier_Id" }, { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->SupplierPartNumber" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetImportance_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeComponentResourceAction": { "title": "BatchGetPlaceholderAssetTypeComponentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Component entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Component entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeComponentResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeComponentResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeComponentResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentResourceActionRequest" } }, "ChangePlaceholderAssetTypeComponentIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeComponent->IsActive" } ] } } }, "ChangePlaceholderAssetTypeComponentPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentPermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeComponent->PermissionTree_Id" } ] } } }, "ClearPlaceholderAssetTypeComponentResourceActionRequest": { "title": "ClearPlaceholderAssetTypeComponentResourceActionRequest", "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" } } } }, "PlaceholderAssetTypeComponentLinkAssetTypeResourceActionRequest": { "title": "PlaceholderAssetTypeComponentLinkAssetTypeResourceActionRequest", "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": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LinkPlaceholderAssetTypeComponentEntity->LinkedToAssetType_Id" } ] } } }, "SetPlaceholderAssetTypeComponentResourceActionRequest": { "title": "SetPlaceholderAssetTypeComponentResourceActionRequest", "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": "componentPlaceholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SetPlaceholderAssetTypeComponentEntity->ComponentPlaceholderForAssetType_Id" } ] } } }, "BatchChangePlaceholderAssetTypeComponentIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeComponentPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentPermissionTreeResourceActionRequest" } }, "BatchClearPlaceholderAssetTypeComponentResourceActionRequest": { "title": "BatchClearPlaceholderAssetTypeComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ClearPlaceholderAssetTypeComponentResourceActionRequest" } }, "BatchLinkPlaceholderAssetTypeComponentResourceActionRequest": { "title": "BatchLinkPlaceholderAssetTypeComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/PlaceholderAssetTypeComponentLinkAssetTypeResourceActionRequest" } }, "BatchSetPlaceholderAssetTypeComponentResourceActionRequest": { "title": "BatchSetPlaceholderAssetTypeComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/SetPlaceholderAssetTypeComponentResourceActionRequest" } }, "MatchUpdatePlaceholderAssetTypeComponentResourceActionRequest": { "title": "MatchUpdatePlaceholderAssetTypeComponentResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeComponent->Quantity" } ] } } }, "GetPlaceholderAssetTypeComponentAttributeResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentAttributeResourceActionResponse", "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": "GetPlaceholderAssetTypeComponentAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Id" }, "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->InheritedFrom" }, "inheritedFromRegularAssetTypeAttribute": { "title": "inheritedFromRegularAssetTypeAttribute", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->InheritedFromRegularAssetTypeAttribute" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->IsBackup" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetPlaceholderAssetTypeComponentAttributeCollectionForPlaceholderAssetTypeComponentResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentAttributeCollectionForPlaceholderAssetTypeComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentAttributeCollectionForPlaceholderAssetTypeComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentAttributeCollectionForPlaceholderAssetTypeComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->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" } } } }, "GetPlaceholderAssetTypeComponentAttributeCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->IsInherited" }, "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->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" } } } }, "PlaceholderAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentAttributeAttributeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentAttributePlaceholderAssetTypeComponentLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentAttributePlaceholderAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentAttributePlaceholderAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentAttributePlaceholderAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->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" } } } }, "CreatePlaceholderAssetTypeComponentAttributeResourceActionRequest": { "title": "CreatePlaceholderAssetTypeComponentAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeComponentAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeComponentId", "attributeId" ], "properties": { "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PlaceholderAssetTypeComponent_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeComponentAttributeResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeComponentAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentAttribute->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeComponentAttributeResourceAction": { "title": "BatchGetPlaceholderAssetTypeComponentAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Component Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Component Attribute entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentAttributeResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeComponentAttributeResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeComponentAttributeResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeComponentAttributeResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentAttributeResourceActionRequest" } }, "ChangePlaceholderAssetTypeComponentAttributeIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentAttributeIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeComponentAttribute->IsActive" } ] } } }, "ChangePlaceholderAssetTypeComponentAttributePermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentAttributePermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeComponentAttribute->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeComponentAttributeIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentAttributeIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeComponentAttributePermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentAttributePermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeComponentConditionResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentConditionResourceActionResponse", "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": "GetPlaceholderAssetTypeComponentConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentCondition->LastConfirmedOn" }, "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id" }, "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Description" }, "placeholderAssetTypeComponentAssetTypeId": { "title": "placeholderAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_Id" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeComponentCondition->State eq 'Apply'" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->InheritedFrom" }, "inheritedFromRegularAssetTypeCondition": { "title": "inheritedFromRegularAssetTypeCondition", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->InheritedFromRegularAssetTypeCondition" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Notes" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->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" } } }, "GetPlaceholderAssetTypeComponentConditionCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code" }, "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Description" }, "conditionState": { "title": "conditionState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_State", "x-formatSpecifier": "ConditionState" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeComponentCondition->State eq 'Apply'" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->IsInherited" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->InheritedFrom" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetPlaceholderAssetTypeComponentConditionForPlaceholderAssetTypeComponentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentConditionForPlaceholderAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentConditionForPlaceholderAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentConditionForPlaceholderAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_ConditionType_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeComponentCondition->State eq 'Apply'" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->IsInherited" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->InheritedFrom" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentConditionChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentConditionConditionLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentConditionConditionLookupResourceActionResponseItemProperties", "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" }, "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" } } } }, "PlaceholderAssetTypeComponentConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentConditionPlaceholderAssetTypeComponentLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentConditionPlaceholderAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentConditionPlaceholderAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentConditionPlaceholderAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Description" }, "assetTypeNearestRegularAssetTypeId": { "title": "assetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Id" }, "assetTypeNearestRegularAssetTypeCode": { "title": "assetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_Code" }, "assetTypeNearestRegularAssetTypeDescription": { "title": "assetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_NearestRegularAssetType_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" } } } }, "PlaceholderAssetTypeComponentConditionRegularAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentConditionRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentConditionRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentConditionRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetTypeComponentConditionResourceActionRequest": { "title": "CreatePlaceholderAssetTypeComponentConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeComponentConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeComponentId", "conditionId", "state" ], "properties": { "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PlaceholderAssetTypeComponent_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->PermissionTree_Id", "x-systemGenerated": true }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Condition_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->SequenceNumber" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeComponentCondition->State eq 'Apply'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeComponentConditionResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeComponentConditionResourceActionRequest", "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": "PlaceholderAssetTypeComponentCondition->SequenceNumber" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeComponentCondition->State eq 'Apply'" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentCondition->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeComponentConditionResourceAction": { "title": "BatchGetPlaceholderAssetTypeComponentConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Component Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Component Condition entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentConditionResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeComponentConditionResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeComponentConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeComponentConditionResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeComponentConditionResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeComponentConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentConditionResourceActionRequest" } }, "ChangePlaceholderAssetTypeComponentConditionIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentConditionIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeComponentCondition->IsActive" } ] } } }, "ChangePlaceholderAssetTypeComponentConditionPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentConditionPermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeComponentCondition->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeComponentConditionIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentConditionIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeComponentConditionPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentConditionPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeComponentDocumentResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentDocumentResourceActionResponse", "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": "GetPlaceholderAssetTypeComponentDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Id" }, "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->InheritedFrom" }, "inheritedFromRegularAssetTypeDocument": { "title": "inheritedFromRegularAssetTypeDocument", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->InheritedFromRegularAssetTypeDocument" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentDocument->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->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" } } }, "GetPlaceholderAssetTypeComponentDocumentCollectionForPlaceholderAssetTypeComponentResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentDocumentCollectionForPlaceholderAssetTypeComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentDocumentCollectionForPlaceholderAssetTypeComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentDocumentCollectionForPlaceholderAssetTypeComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->Notes" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->InheritedFrom" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentDocument->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" } } } }, "GetPlaceholderAssetTypeComponentDocumentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->IsInherited" }, "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentDocument->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" } } } }, "PlaceholderAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentDocumentDocumentRecordLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentDocumentDocumentRecordLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentDocumentDocumentRecordLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentDocumentDocumentRecordLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeComponentDocumentPlaceholderAssetTypeComponentLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentDocumentPlaceholderAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentDocumentPlaceholderAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentDocumentPlaceholderAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->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" } } } }, "CreatePlaceholderAssetTypeComponentDocumentResourceActionRequest": { "title": "CreatePlaceholderAssetTypeComponentDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeComponentDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeComponentId", "documentRecordId" ], "properties": { "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PlaceholderAssetTypeComponent_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeComponentDocumentResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeComponentDocumentResourceActionRequest", "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": "PlaceholderAssetTypeComponentDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentDocument->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeComponentDocumentResourceAction": { "title": "BatchGetPlaceholderAssetTypeComponentDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Component Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Component Document entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentDocumentResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeComponentDocumentResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeComponentDocumentResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeComponentDocumentResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentDocumentResourceActionRequest" } }, "ChangePlaceholderAssetTypeComponentDocumentIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentDocumentIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeComponentDocument->IsActive" } ] } } }, "ChangePlaceholderAssetTypeComponentDocumentPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentDocumentPermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeComponentDocument->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeComponentDocumentIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentDocumentIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeComponentDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentDocumentPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeComponentRuleLinkResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentRuleLinkResourceActionResponse", "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": "GetPlaceholderAssetTypeComponentRuleLinkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->ModifiedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->LastConfirmedOn" }, "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Id" }, "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Description" }, "placeholderAssetTypeComponentAssetTypeId": { "title": "placeholderAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Id" }, "placeholderAssetTypeComponentAssetTypeCode": { "title": "placeholderAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Code" }, "placeholderAssetTypeComponentAssetTypeDescription": { "title": "placeholderAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Description" }, "placeholderAssetTypeComponentAssetTypeRecordType": { "title": "placeholderAssetTypeComponentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code" }, "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription": { "title": "placeholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description" }, "placeholderAssetTypeComponentLinkedToAssetTypeId": { "title": "placeholderAssetTypeComponentLinkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Id" }, "placeholderAssetTypeComponentLinkedToAssetTypeCode": { "title": "placeholderAssetTypeComponentLinkedToAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Code" }, "placeholderAssetTypeComponentLinkedToAssetTypeDescription": { "title": "placeholderAssetTypeComponentLinkedToAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Description" }, "placeholderAssetTypeComponentParentComponentId": { "title": "placeholderAssetTypeComponentParentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Id" }, "placeholderAssetTypeComponentParentComponentCode": { "title": "placeholderAssetTypeComponentParentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Code" }, "placeholderAssetTypeComponentParentComponentDescription": { "title": "placeholderAssetTypeComponentParentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Description" }, "placeholderAssetTypeComponentParentComponentQuantity": { "title": "placeholderAssetTypeComponentParentComponentQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Quantity" }, "placeholderAssetTypeComponentParentComponentRecordType": { "title": "placeholderAssetTypeComponentParentComponentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "placeholderAssetTypeComponentParentComponentAssetTypeId": { "title": "placeholderAssetTypeComponentParentComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Id" }, "placeholderAssetTypeComponentParentComponentAssetTypeCode": { "title": "placeholderAssetTypeComponentParentComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Code" }, "placeholderAssetTypeComponentParentComponentAssetTypeDescription": { "title": "placeholderAssetTypeComponentParentComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_Description" }, "placeholderAssetTypeComponentParentComponentAssetTypeRecordType": { "title": "placeholderAssetTypeComponentParentComponentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId": { "title": "placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Id" }, "placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode": { "title": "placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Code" }, "placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription": { "title": "placeholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Description" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Id" }, "inheritedFromPlaceholderAssetTypeComponentId": { "title": "inheritedFromPlaceholderAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Id" }, "inheritedFromPlaceholderAssetTypeComponentCode": { "title": "inheritedFromPlaceholderAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Code" }, "inheritedFromPlaceholderAssetTypeComponentDescription": { "title": "inheritedFromPlaceholderAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_Description" }, "inheritedFromPlaceholderAssetTypeComponentAssetTypeId": { "title": "inheritedFromPlaceholderAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Id" }, "inheritedFromPlaceholderAssetTypeComponentAssetTypeCode": { "title": "inheritedFromPlaceholderAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Code" }, "inheritedFromPlaceholderAssetTypeComponentAssetTypeDescription": { "title": "inheritedFromPlaceholderAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_Description" }, "inheritedFromPlaceholderAssetTypeComponentAssetTypeRecordType": { "title": "inheritedFromPlaceholderAssetTypeComponentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId": { "title": "inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Id" }, "inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode": { "title": "inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Code" }, "inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription": { "title": "inheritedFromPlaceholderAssetTypeComponentAssetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_AssetType_NearestRegularAssetType_Description" }, "inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeId": { "title": "inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Id" }, "inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeCode": { "title": "inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Code" }, "inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeDescription": { "title": "inheritedFromPlaceholderAssetTypeComponentLinkedToAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_LinkedToAssetType_Description" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentId": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Id" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentCode": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Code" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentDescription": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Description" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentQuantity": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_Quantity" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentRecordType": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeId": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Id" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeCode": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Code" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeDescription": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_Description" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeRecordType": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Id" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Code" }, "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription": { "title": "inheritedFromPlaceholderAssetTypeComponentParentComponentAssetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_PlaceholderAssetTypeComponent_ParentComponent_AssetType_NearestRegularAssetType_Description" }, "inheritedFromRuleId": { "title": "inheritedFromRuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Id" }, "inheritedFromRuleCode": { "title": "inheritedFromRuleCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Code" }, "inheritedFromRuleDescription": { "title": "inheritedFromRuleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_Description" }, "inheritedFromRuleRuleText": { "title": "inheritedFromRuleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleText" }, "inheritedFromRuleRuleCategoryId": { "title": "inheritedFromRuleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Id" }, "inheritedFromRuleRuleCategoryCode": { "title": "inheritedFromRuleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Code" }, "inheritedFromRuleRuleCategoryDescription": { "title": "inheritedFromRuleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Notes" } } }, "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" } } }, "GetPlaceholderAssetTypeComponentRuleLinkCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeComponentRuleLinkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeComponentRuleLinkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeComponentRuleLinkCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetTypeComponentCode": { "title": "placeholderAssetTypeComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Code" }, "placeholderAssetTypeComponentDescription": { "title": "placeholderAssetTypeComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Description" }, "placeholderAssetTypeComponentAssetTypeId": { "title": "placeholderAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Id" }, "placeholderAssetTypeComponentAssetTypeCode": { "title": "placeholderAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Code" }, "placeholderAssetTypeComponentAssetTypeDescription": { "title": "placeholderAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_AssetType_Description" }, "placeholderAssetTypeComponentParentComponentId": { "title": "placeholderAssetTypeComponentParentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Id" }, "placeholderAssetTypeComponentParentComponentCode": { "title": "placeholderAssetTypeComponentParentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Code" }, "placeholderAssetTypeComponentParentComponentDescription": { "title": "placeholderAssetTypeComponentParentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_ParentComponent_Description" }, "placeholderAssetTypeComponentLinkedToAssetTypeId": { "title": "placeholderAssetTypeComponentLinkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Id" }, "placeholderAssetTypeComponentLinkedToAssetTypeCode": { "title": "placeholderAssetTypeComponentLinkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Code" }, "placeholderAssetTypeComponentLinkedToAssetTypeDescription": { "title": "placeholderAssetTypeComponentLinkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_LinkedToAssetType_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->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" } } } }, "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponse": { "title": "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponent->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->AssetType_Description" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponent->ParentComponent_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" } } } }, "PlaceholderAssetTypeComponentRuleLinkRuleLookupResourceActionResponse": { "title": "PlaceholderAssetTypeComponentRuleLinkRuleLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeComponentRuleLinkRuleLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeComponentRuleLinkRuleLookupResourceActionResponseItemProperties", "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" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest": { "title": "CreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeComponentId", "ruleId" ], "properties": { "placeholderAssetTypeComponentId": { "title": "placeholderAssetTypeComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->PlaceholderAssetTypeComponent_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Rule_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest", "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": "PlaceholderAssetTypeComponentRuleLink->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeComponentRuleLink->SequenceNumber" } ] } } }, "BatchGetPlaceholderAssetTypeComponentRuleLinkResourceAction": { "title": "BatchGetPlaceholderAssetTypeComponentRuleLinkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Component Rule Link entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Component Rule Link entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeComponentRuleLinkResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeComponentRuleLinkResourceActionRequest" } }, "ChangePlaceholderAssetTypeComponentRuleLinkIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeComponentRuleLinkIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeComponentRuleLink->IsActive" } ] } } }, "BatchChangePlaceholderAssetTypeComponentRuleLinkIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeComponentRuleLinkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeComponentRuleLinkIsActiveResourceActionRequest" } }, "GetPlaceholderAssetTypeConditionResourceActionResponse": { "title": "GetPlaceholderAssetTypeConditionResourceActionResponse", "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": "GetPlaceholderAssetTypeConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeCondition->LastConfirmedOn" }, "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_Description" }, "placeholderAssetTypeNearestRegularAssetTypeId": { "title": "placeholderAssetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Id" }, "placeholderAssetTypeNearestRegularAssetTypeCode": { "title": "placeholderAssetTypeNearestRegularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Code" }, "placeholderAssetTypeNearestRegularAssetTypeDescription": { "title": "placeholderAssetTypeNearestRegularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_NearestRegularAssetType_Description" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeCondition->State eq 'Apply'" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_ConditionType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->InheritedFrom_Id" }, "inheritedFromConditionId": { "title": "inheritedFromConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->InheritedFrom_Condition_Id" }, "inheritedFromConditionCode": { "title": "inheritedFromConditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->InheritedFrom_Condition_Code" }, "inheritedFromConditionDescription": { "title": "inheritedFromConditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->InheritedFrom_Condition_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->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" } } }, "GetConditionForPlaceholderAssetTypeCollectionResourceActionResponse": { "title": "GetConditionForPlaceholderAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetConditionForPlaceholderAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetConditionForPlaceholderAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_ConditionType_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeCondition->State eq 'Apply'" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->InheritedFrom_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" } } } }, "GetPlaceholderAssetTypeConditionCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Description" }, "conditionState": { "title": "conditionState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeCondition->State eq 'Apply'" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->InheritedFrom_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" } } } }, "PlaceholderAssetTypeConditionChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeConditionConditionLookupResourceActionResponse": { "title": "PlaceholderAssetTypeConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeConditionConditionLookupResourceActionResponseItemProperties", "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" }, "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" } } } }, "PlaceholderAssetTypeConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeConditionPlaceholderAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeConditionPlaceholderAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeConditionPlaceholderAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeConditionPlaceholderAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->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" } } } }, "PlaceholderAssetTypeConditionRegularAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeConditionRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeConditionRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeConditionRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetTypeConditionResourceActionRequest": { "title": "CreatePlaceholderAssetTypeConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeId", "conditionId", "state" ], "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeCondition->PlaceholderAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->PermissionTree_Id", "x-systemGenerated": true }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->Condition_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->SequenceNumber" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeCondition->State eq 'Apply'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeConditionResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeConditionResourceActionRequest", "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": "PlaceholderAssetTypeCondition->SequenceNumber" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "PlaceholderAssetTypeCondition->State eq 'Apply'" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeCondition->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeConditionResourceAction": { "title": "BatchGetPlaceholderAssetTypeConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Condition entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeConditionResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeConditionResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeConditionResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeConditionResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeConditionResourceActionRequest" } }, "ChangePlaceholderAssetTypeConditionIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeConditionIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeCondition->IsActive" } ] } } }, "ChangePlaceholderAssetTypeConditionPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeConditionPermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeCondition->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeConditionIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeConditionIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeConditionPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeConditionPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeDocumentResourceActionResponse": { "title": "GetPlaceholderAssetTypeDocumentResourceActionResponse", "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": "GetPlaceholderAssetTypeDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->PlaceholderAssetType_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->InheritedFrom" }, "inheritedFromRegularAssetTypeDocument": { "title": "inheritedFromRegularAssetTypeDocument", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->InheritedFromRegularAssetTypeDocument" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeDocument->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->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" } } }, "GetPlaceholderAssetTypeDocumentCollectionForPlaceholderAssetTypeResourceActionResponse": { "title": "GetPlaceholderAssetTypeDocumentCollectionForPlaceholderAssetTypeResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeDocumentCollectionForPlaceholderAssetTypeResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeDocumentCollectionForPlaceholderAssetTypeResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->Notes" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->InheritedFrom" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeDocument->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" } } } }, "GetPlaceholderAssetTypeDocumentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->IsInherited" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->PlaceholderAssetType_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeDocument->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" } } } }, "PlaceholderAssetTypeDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeDocumentDocumentLookupResourceActionResponse": { "title": "PlaceholderAssetTypeDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeDocumentPlaceholderAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeDocumentPlaceholderAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeDocumentPlaceholderAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeDocumentPlaceholderAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->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" } } } }, "CreatePlaceholderAssetTypeDocumentResourceActionRequest": { "title": "CreatePlaceholderAssetTypeDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeId", "documentRecordId" ], "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->PlaceholderAssetType_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeDocumentResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeDocumentResourceActionRequest", "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": "PlaceholderAssetTypeDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeDocument->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeDocumentResourceAction": { "title": "BatchGetPlaceholderAssetTypeDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Document entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeDocumentResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeDocumentResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeDocumentResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeDocumentResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeDocumentResourceActionRequest" } }, "ChangePlaceholderAssetTypeDocumentIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeDocumentIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeDocument->IsActive" } ] } } }, "ChangePlaceholderAssetTypeDocumentPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeDocumentPermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeDocument->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeDocumentIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeDocumentIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeDocumentPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeResponsibilityResourceActionResponse": { "title": "GetPlaceholderAssetTypeResponsibilityResourceActionResponse", "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": "GetPlaceholderAssetTypeResponsibilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeResponsibility->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeResponsibility->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeResponsibility->LastConfirmedOn" }, "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Description" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->InheritedFrom_Id" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->LastConfirmedChangeLogId" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_ContactDetailLastName" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_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" } } }, "GetPlaceholderAssetTypeResponsibilityCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeResponsibilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeResponsibilityCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeResponsibilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->SequenceNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeResponsibility->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeResponsibility->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" } } } }, "GetPlaceholderAssetTypeResponsibilityForPlaceholderAssetTypeCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeResponsibilityForPlaceholderAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeResponsibilityForPlaceholderAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeResponsibilityForPlaceholderAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_ContactDetailLastName" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->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" } } } }, "PlaceholderAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeResponsibilityPlaceholderAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeResponsibilityPlaceholderAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeResponsibilityPlaceholderAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeResponsibilityPlaceholderAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->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" } } } }, "PlaceholderAssetTypeResponsibilityResourceLookupResourceActionResponse": { "title": "PlaceholderAssetTypeResponsibilityResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeResponsibilityResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeResponsibilityResourceLookupResourceActionResponseItemProperties", "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" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Section_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" } } } }, "PlaceholderAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse": { "title": "PlaceholderAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponseItemProperties", "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" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Resource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Section_Code" }, "idResourceTradeResourceTradeCode": { "title": "idResourceTradeResourceTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->*Id.ResourceTrade.Resource_Trade_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" } } } }, "PlaceholderAssetTypeResponsibilitySectionLookupResourceActionResponse": { "title": "PlaceholderAssetTypeResponsibilitySectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeResponsibilitySectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeResponsibilitySectionLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeResponsibilityTradeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeResponsibilityTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeResponsibilityTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeResponsibilityTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePlaceholderAssetTypeResponsibilityResourceActionRequest": { "title": "CreatePlaceholderAssetTypeResponsibilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeResponsibilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeId" ], "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PlaceholderAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeResponsibilityResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeResponsibilityResourceActionRequest", "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": "PlaceholderAssetTypeResponsibility->SequenceNumber" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Resource_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeResponsibility->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeResponsibilityResourceAction": { "title": "BatchGetPlaceholderAssetTypeResponsibilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Responsibility entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Responsibility entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeResponsibilityResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeResponsibilityResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeResponsibilityResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeResponsibilityResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeResponsibilityResourceActionRequest" } }, "ChangePlaceholderAssetTypeResponsibilityIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeResponsibilityIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeResponsibility->IsActive" } ] } } }, "ChangePlaceholderAssetTypeResponsibilityPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeResponsibilityPermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeResponsibility->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeResponsibilityIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeResponsibilityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeResponsibilityIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeResponsibilityPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeResponsibilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetTypeRuleLinkResourceActionResponse": { "title": "GetPlaceholderAssetTypeRuleLinkResourceActionResponse", "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": "GetPlaceholderAssetTypeRuleLinkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeRuleLink->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeRuleLink->ModifiedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeRuleLink->LastConfirmedOn" }, "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Description" }, "placeholderAssetTypeLinkedToAssetTypeId": { "title": "placeholderAssetTypeLinkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Id" }, "placeholderAssetTypeLinkedToAssetTypeCode": { "title": "placeholderAssetTypeLinkedToAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Code" }, "placeholderAssetTypeLinkedToAssetTypeDescription": { "title": "placeholderAssetTypeLinkedToAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Description" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Id" }, "inheritedFromPlaceholderAssetTypeId": { "title": "inheritedFromPlaceholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Id" }, "inheritedFromPlaceholderAssetTypeCode": { "title": "inheritedFromPlaceholderAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Code" }, "inheritedFromPlaceholderAssetTypeDescription": { "title": "inheritedFromPlaceholderAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_PlaceholderAssetType_Description" }, "inheritedFromRuleId": { "title": "inheritedFromRuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Id" }, "inheritedFromRuleCode": { "title": "inheritedFromRuleCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Code" }, "inheritedFromRuleDescription": { "title": "inheritedFromRuleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_Description" }, "inheritedFromRuleRuleText": { "title": "inheritedFromRuleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleText" }, "inheritedFromRuleRuleCategoryId": { "title": "inheritedFromRuleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Id" }, "inheritedFromRuleRuleCategoryCode": { "title": "inheritedFromRuleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Code" }, "inheritedFromRuleRuleCategoryDescription": { "title": "inheritedFromRuleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->InheritedFrom_Rule_RuleCategory_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Notes" } } }, "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" } } }, "GetPlaceholderAssetTypeRuleLinkCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeRuleLinkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeRuleLinkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeRuleLinkCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id" }, "placeholderAssetTypeLinkedToAssetTypeId": { "title": "placeholderAssetTypeLinkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Id" }, "placeholderAssetTypeLinkedToAssetTypeCode": { "title": "placeholderAssetTypeLinkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Code" }, "placeholderAssetTypeLinkedToAssetTypeDescription": { "title": "placeholderAssetTypeLinkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_LinkedToAssetType_Description" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->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" } } } }, "GetRuleLinkForPlaceholderAssetTypeCollectionResourceActionResponse": { "title": "GetRuleLinkForPlaceholderAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleLinkForPlaceholderAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleLinkForPlaceholderAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeRuleLinkTaskPlaceholderAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeRuleLinkTaskPlaceholderAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeRuleLinkTaskPlaceholderAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeRuleLinkTaskPlaceholderAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Description" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->LinkedToAssetType_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" } } } }, "PlaceholderAssetTypeRuleLinkRuleLookupResourceActionResponse": { "title": "PlaceholderAssetTypeRuleLinkRuleLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeRuleLinkRuleLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeRuleLinkRuleLookupResourceActionResponseItemProperties", "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" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetTypeRuleLinkResourceActionRequest": { "title": "CreatePlaceholderAssetTypeRuleLinkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeRuleLinkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeId", "ruleId" ], "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->PlaceholderAssetType_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Rule_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeRuleLinkResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeRuleLinkResourceActionRequest", "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": "PlaceholderAssetTypeRuleLink->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeRuleLink->SequenceNumber" } ] } } }, "BatchGetPlaceholderAssetTypeRuleLinkResourceAction": { "title": "BatchGetPlaceholderAssetTypeRuleLinkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Rule Link entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Rule Link entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeRuleLinkResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeRuleLinkResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeRuleLinkResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeRuleLinkResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeRuleLinkResourceActionRequest" } }, "ChangePlaceholderAssetTypeRuleLinkIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeRuleLinkIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeRuleLink->IsActive" } ] } } }, "BatchChangePlaceholderAssetTypeRuleLinkIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeRuleLinkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeRuleLinkIsActiveResourceActionRequest" } }, "GetPlaceholderAssetTypeSpareResourceActionResponse": { "title": "GetPlaceholderAssetTypeSpareResourceActionResponse", "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": "GetPlaceholderAssetTypeSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetTypeSpare->LastConfirmedOn" }, "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->PlaceholderAssetType_Description" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->InheritedFrom_Id" }, "inheritedFromMaterialMasterId": { "title": "inheritedFromMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Id" }, "inheritedFromMaterialMasterCode": { "title": "inheritedFromMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Code" }, "inheritedFromMaterialMasterDescription": { "title": "inheritedFromMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->InheritedFrom_MaterialMaster_Description" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsEmergency" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "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" } } }, "GetPlaceholderAssetTypeSpareCollectionResourceActionResponse": { "title": "GetPlaceholderAssetTypeSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetTypeSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetTypeSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->PlaceholderAssetType_Id" }, "placeholderAssetTypeCode": { "title": "placeholderAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->PlaceholderAssetType_Code" }, "placeholderAssetTypeDescription": { "title": "placeholderAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->PlaceholderAssetType_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetSpareForPlaceholderAssetTypeCollectionResourceActionResponse": { "title": "GetSpareForPlaceholderAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForPlaceholderAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForPlaceholderAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsEmergency" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsInherited" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsCritical" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetTypeSpareChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeSpareMaterialMasterLookupResourceActionResponse": { "title": "PlaceholderAssetTypeSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTypeSparePlaceholderAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetTypeSparePlaceholderAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTypeSparePlaceholderAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTypeSparePlaceholderAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetType->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" } } } }, "CreatePlaceholderAssetTypeSpareResourceActionRequest": { "title": "CreatePlaceholderAssetTypeSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetTypeSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetTypeId", "materialMasterId", "isCritical", "isEmergency" ], "properties": { "placeholderAssetTypeId": { "title": "placeholderAssetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetTypeSpare->PlaceholderAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->PermissionTree_Id", "x-systemGenerated": true }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->MaterialMaster_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->SequenceNumber" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsEmergency" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetTypeSpareResourceActionRequest": { "title": "UpdatePlaceholderAssetTypeSpareResourceActionRequest", "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": "PlaceholderAssetTypeSpare->SequenceNumber" }, { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsCritical" }, { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetTypeSpare->IsEmergency" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetTypeSpare->Notes" } ] } } }, "BatchGetPlaceholderAssetTypeSpareResourceAction": { "title": "BatchGetPlaceholderAssetTypeSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Type Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Type Spare entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetTypeSpareResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetTypeSpareResourceActionRequest": { "title": "BatchCreatePlaceholderAssetTypeSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetTypeSpareResourceActionRequest" } }, "BatchUpdatePlaceholderAssetTypeSpareResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetTypeSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetTypeSpareResourceActionRequest" } }, "ChangePlaceholderAssetTypeSpareIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetTypeSpareIsActiveResourceActionRequest", "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": "PlaceholderAssetTypeSpare->IsActive" } ] } } }, "ChangePlaceholderAssetTypeSparePermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetTypeSparePermissionTreeResourceActionRequest", "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": "PlaceholderAssetTypeSpare->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetTypeSpareIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeSpareIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetTypeSparePermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetTypeSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetTypeSparePermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeResourceActionResponse": { "title": "GetRegularAssetTypeResourceActionResponse", "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": "GetRegularAssetTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetType->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetType->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetType->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetType->LastConfirmedOn" }, "nearestRegularAssetTypeId": { "title": "nearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetType->NearestRegularAssetType_Id" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Description" }, "parentAssetTypeRecordType": { "title": "parentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetType->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetType->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "allowConditions": { "title": "allowConditions", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetType->AllowConditions" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->AssetImportance_Description" }, "canSelectOnAsset": { "title": "canSelectOnAsset", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetType->CanSelectOnAsset" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->TaskRollUpPoint_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" } } }, "GetRegularAssetTypeCollectionResourceActionResponse": { "title": "GetRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetType->IsActive" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->AlternativeDescription" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->PermissionTree_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetType->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetType->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->AssetImportance_Description" }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Id" }, "parentAssetTypeCode": { "title": "parentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Code" }, "parentAssetTypeDescription": { "title": "parentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_Description" }, "parentAssetTypeRecordType": { "title": "parentAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->ParentAssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetType->ModifiedOn" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetType->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeAssetImportanceLookupResourceActionResponse": { "title": "RegularAssetTypeAssetImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeAssetImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeAssetImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->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" } } } }, "RegularAssetTypeAssetTypeParentLookupResourceActionResponse": { "title": "RegularAssetTypeAssetTypeParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeAssetTypeParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeAssetTypeParentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskRollUpPointLookupResourceActionResponse": { "title": "RegularAssetTypeTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTypeResourceActionRequest": { "title": "CreateRegularAssetTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "canSelectOnAsset", "description", "parentAssetTypeId" ], "properties": { "allowConditions": { "title": "allowConditions", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetType->AllowConditions" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetType->AlternativeDescription", "x-systemGenerated": true }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->AssetImportance_Id" }, "canSelectOnAsset": { "title": "canSelectOnAsset", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetType->CanSelectOnAsset" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetType->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetType->PermissionTree_Id", "x-systemGenerated": true }, "parentAssetTypeId": { "title": "parentAssetTypeId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "x-propertyPath": "RegularAssetType->ParentAssetType_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetType->TaskRollUpPoint_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetType->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeResourceActionRequest": { "title": "UpdateRegularAssetTypeResourceActionRequest", "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": "RegularAssetType->SequenceNumber" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetType->AlternativeDescription" }, { "title": "allowConditions", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetType->AllowConditions" }, { "title": "canSelectOnAsset", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetType->CanSelectOnAsset" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetType->TaskRollUpPoint_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetType->Notes" } ] } } }, "DeleteRegularAssetTypeResourceActionRequest": { "title": "DeleteRegularAssetTypeResourceActionRequest", "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 } } }, "BatchGetRegularAssetTypeResourceAction": { "title": "BatchGetRegularAssetTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeResourceActionRequest": { "title": "BatchCreateRegularAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeResourceActionRequest" } }, "BatchUpdateRegularAssetTypeResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeResourceActionRequest" } }, "BatchDeleteRegularAssetTypeResourceActionRequest": { "title": "BatchDeleteRegularAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTypeResourceActionRequest" } }, "ChangeRegularAssetTypeIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeIsActiveResourceActionRequest", "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": "RegularAssetType->IsActive" } ] } } }, "ChangeRegularAssetTypePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypePermissionTreeResourceActionRequest", "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": "RegularAssetType->PermissionTree_Id" } ] } } }, "MoveRegularAssetTypeResourceActionRequest": { "title": "MoveRegularAssetTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "MoveRegularAssetTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "sourceId", "targetId", "targetType" ], "properties": { "sourceId": { "title": "sourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MoveEntity->SourceId" }, "targetId": { "title": "targetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MoveEntity->TargetId" }, "targetType": { "title": "targetType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "MoveEntity->TargetType", "x-formatSpecifier": "EntityType" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeRegularAssetTypeIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypePermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTypeResourceActionRequest": { "title": "MatchUpdateRegularAssetTypeResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "canSelectOnAsset", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetType->CanSelectOnAsset" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetType->TaskRollUpPoint_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetType->AssetImportance_Id" } ] } } }, "GetRegularAssetTypeAttributeResourceActionResponse": { "title": "GetRegularAssetTypeAttributeResourceActionResponse", "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": "GetRegularAssetTypeAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->RegularAssetType_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->InheritedFrom" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->IsBackup" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeAttribute->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRegularAssetTypeAttributeCollectionForRegularAssetTypeResourceActionResponse": { "title": "GetRegularAssetTypeAttributeCollectionForRegularAssetTypeResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeAttributeCollectionForRegularAssetTypeResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeAttributeCollectionForRegularAssetTypeResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeAttribute->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" } } } }, "GetRegularAssetTypeAttributeCollectionResourceActionResponse": { "title": "GetRegularAssetTypeAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->IsInherited" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->RegularAssetType_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeAttribute->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" } } } }, "RegularAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RegularAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeAttributeAttributeLookupResourceActionResponse": { "title": "RegularAssetTypeAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeAttributeRegularAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeAttributeRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeAttributeRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeAttributeRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeAttributeResourceActionRequest": { "title": "CreateRegularAssetTypeAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeId", "attributeId" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->RegularAssetType_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeAttributeResourceActionRequest": { "title": "UpdateRegularAssetTypeAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeAttribute->Notes" } ] } } }, "BatchGetRegularAssetTypeAttributeResourceAction": { "title": "BatchGetRegularAssetTypeAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Attribute entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeAttributeResourceActionRequest": { "title": "BatchCreateRegularAssetTypeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeAttributeResourceActionRequest" } }, "BatchUpdateRegularAssetTypeAttributeResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeAttributeResourceActionRequest" } }, "ChangeRegularAssetTypeAttributeIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeAttributeIsActiveResourceActionRequest", "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": "RegularAssetTypeAttribute->IsActive" } ] } } }, "ChangeRegularAssetTypeAttributePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeAttributePermissionTreeResourceActionRequest", "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": "RegularAssetTypeAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeAttributeIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeAttributePermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeComponentResourceActionResponse": { "title": "GetRegularAssetTypeComponentResourceActionResponse", "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": "GetRegularAssetTypeComponentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeTreePathId": { "title": "assetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_TreePathId" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeComponent->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->LastConfirmedOn" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Description" }, "parentComponentTreePathId": { "title": "parentComponentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_TreePathId" }, "parentComponentTreePathItems": { "title": "parentComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SequenceNumber" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->RulesLastChangedOn" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Barcode" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->InheritedFrom_Id" }, "inheritedFromTreePathId": { "title": "inheritedFromTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->InheritedFrom_TreePathId" }, "inheritedFromTreePathItems": { "title": "inheritedFromTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeComponent->InheritedFrom_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->IsHistorical" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Notes" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PartNumber" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SerialNumber" }, "specification": { "title": "specification", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Specification" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Description" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SupplierPartNumber" } } }, "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" } } }, "GetRegularAssetTypeComponentCollectionResourceActionResponse": { "title": "GetRegularAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PartNumber" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SupplierPartNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Quantity" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Description" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Description" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeComponent->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->InheritedFrom_Id" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->RulesLastChangedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponent->ModifiedOn" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeComponentAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeComponentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeComponentImportanceLookupResourceActionResponse": { "title": "RegularAssetTypeComponentImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->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" } } } }, "RegularAssetTypeComponentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeComponentsMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetTypeComponentsMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentsMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentsMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "AssetTypeComponentParentComponentLookupResourceActionResponse": { "title": "AssetTypeComponentParentComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetTypeComponentParentComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetTypeComponentParentComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeComponentSupplierLookupResourceActionResponse": { "title": "RegularAssetTypeComponentSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTypeComponentResourceActionRequest": { "title": "CreateRegularAssetTypeComponentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeComponentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetTypeId", "description", "quantity" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AlternativeDescription", "x-systemGenerated": true }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Id" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->PermissionTree_Id", "x-systemGenerated": true }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->ParentComponent_Id" }, "partNumber": { "title": "partNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PartNumber" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Id" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeComponent->Quantity" }, "specification": { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Specification" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Id" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SupplierPartNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SequenceNumber" }, "barcode": { "title": "barcode", "type": "string", "maxLength": 900, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Barcode" }, "serialNumber": { "title": "serialNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SerialNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeComponentResourceActionRequest": { "title": "UpdateRegularAssetTypeComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "readOnly": true, "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code", "x-ReadOnlyExpression": "RegularAssetTypeComponent->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Description", "x-ReadOnlyExpression": "RegularAssetTypeComponent->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->AlternativeDescription" }, { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeComponent->Quantity" }, { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Specification" }, { "title": "partNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->PartNumber" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->MaterialMaster_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SequenceNumber" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Supplier_Id" }, { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SupplierPartNumber" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetImportance_Id" }, { "title": "barcode", "type": "string", "maxLength": 900, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Barcode" }, { "title": "serialNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->SerialNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->Notes" } ] } } }, "BatchGetRegularAssetTypeComponentResourceAction": { "title": "BatchGetRegularAssetTypeComponentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Component entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Component entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeComponentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeComponentResourceActionRequest": { "title": "BatchCreateRegularAssetTypeComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeComponentResourceActionRequest" } }, "BatchUpdateRegularAssetTypeComponentResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentResourceActionRequest" } }, "ChangeRegularAssetTypeComponentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeComponentIsActiveResourceActionRequest", "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": "RegularAssetTypeComponent->IsActive" } ] } } }, "ChangeRegularAssetTypeComponentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeComponentPermissionTreeResourceActionRequest", "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": "RegularAssetTypeComponent->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeComponentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeComponentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeComponentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeComponentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentPermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTypeComponentResourceActionRequest": { "title": "MatchUpdateRegularAssetTypeComponentResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeComponent->Quantity" } ] } } }, "GetRegularAssetTypeComponentAttributeResourceActionResponse": { "title": "GetRegularAssetTypeComponentAttributeResourceActionResponse", "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": "GetRegularAssetTypeComponentAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->InheritedFrom_Id" }, "regularAssetTypeComponentId": { "title": "regularAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Id" }, "regularAssetTypeComponentCode": { "title": "regularAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Code" }, "regularAssetTypeComponentDescription": { "title": "regularAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Description" }, "regularAssetTypeComponentAssetTypeId": { "title": "regularAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Id" }, "regularAssetTypeComponentAssetTypeCode": { "title": "regularAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Code" }, "regularAssetTypeComponentAssetTypeDescription": { "title": "regularAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->IsBackup" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRegularAssetTypeComponentAttributeCollectionForRegularAssetTypeComponentResourceActionResponse": { "title": "GetRegularAssetTypeComponentAttributeCollectionForRegularAssetTypeComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeComponentAttributeCollectionForRegularAssetTypeComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeComponentAttributeCollectionForRegularAssetTypeComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->ModifiedOn" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->LastConfirmedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTypeComponentAttributeCollectionResourceActionResponse": { "title": "GetRegularAssetTypeComponentAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeComponentAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeComponentAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeComponentCode": { "title": "regularAssetTypeComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Code" }, "regularAssetTypeComponentDescription": { "title": "regularAssetTypeComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Description" }, "regularAssetTypeComponentAlternativeDescription": { "title": "regularAssetTypeComponentAlternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AlternativeDescription" }, "regularAssetTypeComponentAssetTypeCode": { "title": "regularAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Code" }, "regularAssetTypeComponentAssetTypeDescription": { "title": "regularAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_AssetType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentAttribute->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" } } } }, "RegularAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RegularAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeComponentAttributeAttributeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeComponentAttributeRegularAssetTypeComponentLookupResourceActionResponse": { "title": "RegularAssetTypeComponentAttributeRegularAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentAttributeRegularAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentAttributeRegularAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_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" } } } }, "CreateRegularAssetTypeComponentAttributeResourceActionRequest": { "title": "CreateRegularAssetTypeComponentAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeComponentAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeComponentId", "attributeId" ], "properties": { "regularAssetTypeComponentId": { "title": "regularAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->RegularAssetTypeComponent_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeComponentAttributeResourceActionRequest": { "title": "UpdateRegularAssetTypeComponentAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentAttribute->Notes" } ] } } }, "BatchGetRegularAssetTypeComponentAttributeResourceAction": { "title": "BatchGetRegularAssetTypeComponentAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Component Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Component Attribute entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeComponentAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeComponentAttributeResourceActionRequest": { "title": "BatchCreateRegularAssetTypeComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeComponentAttributeResourceActionRequest" } }, "BatchUpdateRegularAssetTypeComponentAttributeResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentAttributeResourceActionRequest" } }, "ChangeRegularAssetTypeComponentAttributeIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeComponentAttributeIsActiveResourceActionRequest", "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": "RegularAssetTypeComponentAttribute->IsActive" } ] } } }, "ChangeRegularAssetTypeComponentAttributePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeComponentAttributePermissionTreeResourceActionRequest", "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": "RegularAssetTypeComponentAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeComponentAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeComponentAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentAttributeIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeComponentAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeComponentAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentAttributePermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeComponentDocumentResourceActionResponse": { "title": "GetRegularAssetTypeComponentDocumentResourceActionResponse", "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": "GetRegularAssetTypeComponentDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetTypeComponentId": { "title": "regularAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Id" }, "regularAssetTypeComponentCode": { "title": "regularAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Code" }, "regularAssetTypeComponentDescription": { "title": "regularAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->InheritedFrom" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentDocument->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->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" } } }, "GetRegularAssetTypeComponentDocumentCollectionForRegularAssetTypeComponentResourceActionResponse": { "title": "GetRegularAssetTypeComponentDocumentCollectionForRegularAssetTypeComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeComponentDocumentCollectionForRegularAssetTypeComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeComponentDocumentCollectionForRegularAssetTypeComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->Notes" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->InheritedFrom" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentDocument->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" } } } }, "GetRegularAssetTypeComponentDocumentCollectionResourceActionResponse": { "title": "GetRegularAssetTypeComponentDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeComponentDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeComponentDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->IsInherited" }, "regularAssetTypeComponentCode": { "title": "regularAssetTypeComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Code" }, "regularAssetTypeComponentDescription": { "title": "regularAssetTypeComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentDocument->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" } } } }, "RegularAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeComponentDocumentDocumentLookupResourceActionResponse": { "title": "RegularAssetTypeComponentDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeComponentDocumentRegularAssetTypeComponentLookupResourceActionResponse": { "title": "RegularAssetTypeComponentDocumentRegularAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentDocumentRegularAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentDocumentRegularAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->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" } } } }, "CreateRegularAssetTypeComponentDocumentResourceActionRequest": { "title": "CreateRegularAssetTypeComponentDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeComponentDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeComponentId", "documentRecordId" ], "properties": { "regularAssetTypeComponentId": { "title": "regularAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->RegularAssetTypeComponent_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeComponentDocumentResourceActionRequest": { "title": "UpdateRegularAssetTypeComponentDocumentResourceActionRequest", "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": "RegularAssetTypeComponentDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentDocument->Notes" } ] } } }, "BatchGetRegularAssetTypeComponentDocumentResourceAction": { "title": "BatchGetRegularAssetTypeComponentDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Component Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Component Document entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeComponentDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeComponentDocumentResourceActionRequest": { "title": "BatchCreateRegularAssetTypeComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeComponentDocumentResourceActionRequest" } }, "BatchUpdateRegularAssetTypeComponentDocumentResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentDocumentResourceActionRequest" } }, "ChangeRegularAssetTypeComponentDocumentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeComponentDocumentIsActiveResourceActionRequest", "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": "RegularAssetTypeComponentDocument->IsActive" } ] } } }, "ChangeRegularAssetTypeComponentDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeComponentDocumentPermissionTreeResourceActionRequest", "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": "RegularAssetTypeComponentDocument->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeComponentDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeComponentDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentDocumentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeComponentDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeComponentDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentDocumentPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeComponentRuleLinkResourceActionResponse": { "title": "GetRegularAssetTypeComponentRuleLinkResourceActionResponse", "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": "GetRegularAssetTypeComponentRuleLinkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentRuleLink->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentRuleLink->ModifiedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeComponentRuleLink->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeComponentId": { "title": "regularAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id" }, "regularAssetTypeComponentCode": { "title": "regularAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Code" }, "regularAssetTypeComponentDescription": { "title": "regularAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Description" }, "regularAssetTypeComponentAssetTypeId": { "title": "regularAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Id" }, "regularAssetTypeComponentAssetTypeCode": { "title": "regularAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Code" }, "regularAssetTypeComponentAssetTypeDescription": { "title": "regularAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeComponentId": { "title": "inheritedFromRegularAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Id" }, "inheritedFromRegularAssetTypeComponentCode": { "title": "inheritedFromRegularAssetTypeComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Code" }, "inheritedFromRegularAssetTypeComponentDescription": { "title": "inheritedFromRegularAssetTypeComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_Description" }, "inheritedFromRegularAssetTypeComponentAssetTypeId": { "title": "inheritedFromRegularAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Id" }, "inheritedFromRegularAssetTypeComponentAssetTypeCode": { "title": "inheritedFromRegularAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Code" }, "inheritedFromRegularAssetTypeComponentAssetTypeDescription": { "title": "inheritedFromRegularAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_RegularAssetTypeComponent_AssetType_Description" }, "inheritedFromRuleId": { "title": "inheritedFromRuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Id" }, "inheritedFromRuleCode": { "title": "inheritedFromRuleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Code" }, "inheritedFromRuleDescription": { "title": "inheritedFromRuleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_Description" }, "inheritedFromRuleRuleCategoryId": { "title": "inheritedFromRuleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Id" }, "inheritedFromRuleRuleCategoryCode": { "title": "inheritedFromRuleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Code" }, "inheritedFromRuleRuleCategoryDescription": { "title": "inheritedFromRuleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->InheritedFrom_Rule_RuleCategory_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Notes" } } }, "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" } } }, "GetRegularAssetTypeComponentRuleLinkCollectionResourceActionResponse": { "title": "GetRegularAssetTypeComponentRuleLinkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeComponentRuleLinkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeComponentRuleLinkCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeComponentId": { "title": "regularAssetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id" }, "regularAssetTypeComponentAssetTypeId": { "title": "regularAssetTypeComponentAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Id" }, "regularAssetTypeComponentAssetTypeCode": { "title": "regularAssetTypeComponentAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Code" }, "regularAssetTypeComponentAssetTypeDescription": { "title": "regularAssetTypeComponentAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_AssetType_Description" }, "regularAssetTypeComponentCode": { "title": "regularAssetTypeComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Code" }, "regularAssetTypeComponentDescription": { "title": "regularAssetTypeComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->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" } } } }, "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponse2": { "title": "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleLinkForRegularAssetTypeComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponse": { "title": "RegularAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentRuleLinkTaskRegularAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponent->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponent->AssetType_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" } } } }, "RegularAssetTypeComponentRuleLinkRuleLookupResourceActionResponse": { "title": "RegularAssetTypeComponentRuleLinkRuleLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeComponentRuleLinkRuleLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeComponentRuleLinkRuleLookupResourceActionResponseItemProperties", "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" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeComponentRuleLinkResourceActionRequest": { "title": "CreateRegularAssetTypeComponentRuleLinkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeComponentRuleLinkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeComponentId", "ruleId" ], "properties": { "regularAssetTypeComponentId": { "title": "regularAssetTypeComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->RegularAssetTypeComponent_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Rule_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeComponentRuleLinkResourceActionRequest": { "title": "UpdateRegularAssetTypeComponentRuleLinkResourceActionRequest", "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": "RegularAssetTypeComponentRuleLink->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeComponentRuleLink->SequenceNumber" } ] } } }, "BatchGetRegularAssetTypeComponentRuleLinkResourceAction": { "title": "BatchGetRegularAssetTypeComponentRuleLinkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Component Rule Link entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Component Rule Link entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeComponentRuleLinkResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeComponentRuleLinkResourceActionRequest": { "title": "BatchCreateRegularAssetTypeComponentRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeComponentRuleLinkResourceActionRequest" } }, "BatchUpdateRegularAssetTypeComponentRuleLinkResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeComponentRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeComponentRuleLinkResourceActionRequest" } }, "ChangeRegularAssetTypeComponentRuleLinkIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeComponentRuleLinkIsActiveResourceActionRequest", "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": "RegularAssetTypeComponentRuleLink->IsActive" } ] } } }, "BatchChangeRegularAssetTypeComponentRuleLinkIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeComponentRuleLinkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeComponentRuleLinkIsActiveResourceActionRequest" } }, "GetRegularAssetTypeConditionResourceActionResponse": { "title": "GetRegularAssetTypeConditionResourceActionResponse", "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": "GetRegularAssetTypeConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeCondition->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->RegularAssetType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "RegularAssetTypeCondition->State eq 'Apply'" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Condition_ConditionType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->InheritedFrom_Id" }, "inheritedFromConditionId": { "title": "inheritedFromConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->InheritedFrom_Condition_Id" }, "inheritedFromConditionCode": { "title": "inheritedFromConditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->InheritedFrom_Condition_Code" }, "inheritedFromConditionDescription": { "title": "inheritedFromConditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->InheritedFrom_Condition_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->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" } } }, "GetConditionForRegularAssetTypeCollectionResourceActionResponse": { "title": "GetConditionForRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetConditionForRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetConditionForRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_ConditionType_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "RegularAssetTypeCondition->State eq 'Apply'" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->InheritedFrom_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" } } } }, "GetRegularAssetTypeConditionCollectionResourceActionResponse": { "title": "GetRegularAssetTypeConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->RegularAssetType_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_Description" }, "conditionState": { "title": "conditionState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_State", "x-formatSpecifier": "ConditionState" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_ConditionType_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "RegularAssetTypeCondition->State eq 'Apply'" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->InheritedFrom_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" } } } }, "RegularAssetTypeConditionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeConditionConditionLookupResourceActionResponse": { "title": "RegularAssetTypeConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeConditionConditionLookupResourceActionResponseItemProperties", "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" }, "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" } } } }, "RegularAssetTypeConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeConditionRegularAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeConditionRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeConditionRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeConditionRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeConditionResourceActionRequest": { "title": "CreateRegularAssetTypeConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeId", "conditionId", "state" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeCondition->RegularAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->PermissionTree_Id", "x-systemGenerated": true }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->Condition_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->SequenceNumber" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "RegularAssetTypeCondition->State eq 'Apply'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeConditionResourceActionRequest": { "title": "UpdateRegularAssetTypeConditionResourceActionRequest", "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": "RegularAssetTypeCondition->SequenceNumber" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeCondition->AdjustmentFactor", "x-NullExpression": "RegularAssetTypeCondition->State eq 'Apply'" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeCondition->Notes" } ] } } }, "BatchGetRegularAssetTypeConditionResourceAction": { "title": "BatchGetRegularAssetTypeConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Condition entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeConditionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeConditionResourceActionRequest": { "title": "BatchCreateRegularAssetTypeConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeConditionResourceActionRequest" } }, "BatchUpdateRegularAssetTypeConditionResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeConditionResourceActionRequest" } }, "ChangeRegularAssetTypeConditionIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeConditionIsActiveResourceActionRequest", "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": "RegularAssetTypeCondition->IsActive" } ] } } }, "ChangeRegularAssetTypeConditionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeConditionPermissionTreeResourceActionRequest", "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": "RegularAssetTypeCondition->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeConditionIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeConditionIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeConditionPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeConditionPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeDocumentResourceActionResponse": { "title": "GetRegularAssetTypeDocumentResourceActionResponse", "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": "GetRegularAssetTypeDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->RegularAssetType_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->InheritedFrom" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeDocument->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->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" } } }, "GetRegularAssetTypeDocumentCollectionForRegularAssetTypeResourceActionResponse": { "title": "GetRegularAssetTypeDocumentCollectionForRegularAssetTypeResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeDocumentCollectionForRegularAssetTypeResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeDocumentCollectionForRegularAssetTypeResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->Notes" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->InheritedFrom" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeDocument->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" } } } }, "GetRegularAssetTypeDocumentCollectionResourceActionResponse": { "title": "GetRegularAssetTypeDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->IsInherited" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->RegularAssetType_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeDocument->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" } } } }, "RegularAssetTypeDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeDocumentDocumentLookupResourceActionResponse": { "title": "RegularAssetTypeDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeDocumentRegularAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeDocumentRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeDocumentRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeDocumentRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeDocumentResourceActionRequest": { "title": "CreateRegularAssetTypeDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeId", "documentRecordId" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->RegularAssetType_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeDocumentResourceActionRequest": { "title": "UpdateRegularAssetTypeDocumentResourceActionRequest", "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": "RegularAssetTypeDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeDocument->Notes" } ] } } }, "BatchGetRegularAssetTypeDocumentResourceAction": { "title": "BatchGetRegularAssetTypeDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Document entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeDocumentResourceActionRequest": { "title": "BatchCreateRegularAssetTypeDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeDocumentResourceActionRequest" } }, "BatchUpdateRegularAssetTypeDocumentResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeDocumentResourceActionRequest" } }, "ChangeRegularAssetTypeDocumentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeDocumentIsActiveResourceActionRequest", "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": "RegularAssetTypeDocument->IsActive" } ] } } }, "ChangeRegularAssetTypeDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeDocumentPermissionTreeResourceActionRequest", "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": "RegularAssetTypeDocument->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeDocumentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeDocumentPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeFileAttachmentResourceActionResponse": { "title": "GetRegularAssetTypeFileAttachmentResourceActionResponse", "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": "GetRegularAssetTypeFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "RegularAssetTypeFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRegularAssetTypeFileAttachmentCollectionForRegularAssetTypeResourceActionResponse": { "title": "GetRegularAssetTypeFileAttachmentCollectionForRegularAssetTypeResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeFileAttachmentCollectionForRegularAssetTypeResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeFileAttachmentCollectionForRegularAssetTypeResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeFileAttachment->ModifiedOn" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_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" } } } }, "GetRegularAssetTypeFileAttachmentCollectionResourceActionResponse": { "title": "GetRegularAssetTypeFileAttachmentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeFileAttachmentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeFileAttachment->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" } } } }, "CreateRegularAssetTypeFileAttachmentResourceActionRequest": { "title": "CreateRegularAssetTypeFileAttachmentResourceActionRequest", "type": "object", "required": [ "regularAssetTypeId" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateRegularAssetTypeFileAttachmentContentResourceActionRequest": { "title": "UpdateRegularAssetTypeFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateRegularAssetTypeFileAttachmentResourceActionRequest": { "title": "UpdateRegularAssetTypeFileAttachmentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->IsRestricted" } ] } } }, "DeleteRegularAssetTypeFileAttachmentResourceResourceActionRequest": { "title": "DeleteRegularAssetTypeFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetRegularAssetTypeFileAttachmentResourceAction": { "title": "BatchGetRegularAssetTypeFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type File Attachment entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeFileAttachmentResourceActionResponse" } }, "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" } } }, "GetRegularAssetTypeFileAttachmentContentHistoryResourceActionResponse": { "title": "GetRegularAssetTypeFileAttachmentContentHistoryResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetRegularAssetTypeFileAttachmentContentHistoryResourceAction": { "title": "GetRegularAssetTypeFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type File Attachment entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeFileAttachmentResourceActionRequest": { "title": "BatchCreateRegularAssetTypeFileAttachmentResourceActionRequest", "type": "object", "required": [ "regularAssetTypeId" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->RegularAssetType_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateRegularAssetTypeFileAttachmentResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeFileAttachmentResourceActionRequest" } }, "BatchDeleteRegularAssetTypeFileAttachmentResourceActionRequest": { "title": "BatchDeleteRegularAssetTypeFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTypeFileAttachmentResourceResourceActionRequest" } }, "GetRegularAssetTypeMonitoringPointTriggerResourceActionResponse": { "title": "GetRegularAssetTypeMonitoringPointTriggerResourceActionResponse", "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": "GetRegularAssetTypeMonitoringPointTriggerResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->InheritedFrom_Id" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->LastConfirmedChangeLogId" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Code" }, "monitoringPointTriggerDescription": { "title": "monitoringPointTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->Notes" } } }, "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" } } }, "GetRegularAssetTypeMonitoringPointTriggerCollectionResourceActionResponse": { "title": "GetRegularAssetTypeMonitoringPointTriggerCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeMonitoringPointTriggerCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeMonitoringPointTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Description" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Code" }, "monitoringPointTriggerDescription": { "title": "monitoringPointTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->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" } } } }, "GetRegularAssetTypeMonitoringPointTriggerForRegularAssetTypeCollectionResourceActionResponse": { "title": "GetRegularAssetTypeMonitoringPointTriggerForRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeMonitoringPointTriggerForRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeMonitoringPointTriggerForRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->SequenceNumber" }, "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Description" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Code" }, "monitoringPointTriggerDescription": { "title": "monitoringPointTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->IsInherited" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeMonitoringPointTriggerMonitoringPointTriggerLookupResourceActionResponse": { "title": "RegularAssetTypeMonitoringPointTriggerMonitoringPointTriggerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeMonitoringPointTriggerMonitoringPointTriggerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeMonitoringPointTriggerMonitoringPointTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTrigger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTrigger->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" } } } }, "RegularAssetTypeMonitoringPointTriggerRegularAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeMonitoringPointTriggerRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeMonitoringPointTriggerRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeMonitoringPointTriggerRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeMonitoringPointTriggerResourceActionRequest": { "title": "CreateRegularAssetTypeMonitoringPointTriggerResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeMonitoringPointTriggerResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeId", "monitoringPointTriggerId" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->RegularAssetType_Id" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeMonitoringPointTriggerResourceActionRequest": { "title": "UpdateRegularAssetTypeMonitoringPointTriggerResourceActionRequest", "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": "RegularAssetTypeMonitoringPointTrigger->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeMonitoringPointTrigger->Notes" } ] } } }, "BatchGetRegularAssetTypeMonitoringPointTriggerResourceAction": { "title": "BatchGetRegularAssetTypeMonitoringPointTriggerResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Monitoring Point Trigger entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Monitoring Point Trigger entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeMonitoringPointTriggerResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeMonitoringPointTriggerResourceActionRequest": { "title": "BatchCreateRegularAssetTypeMonitoringPointTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeMonitoringPointTriggerResourceActionRequest" } }, "BatchUpdateRegularAssetTypeMonitoringPointTriggerResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeMonitoringPointTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeMonitoringPointTriggerResourceActionRequest" } }, "ChangeRegularAssetTypeMonitoringPointTriggerIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeMonitoringPointTriggerIsActiveResourceActionRequest", "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": "RegularAssetTypeMonitoringPointTrigger->IsActive" } ] } } }, "ChangeRegularAssetTypeMonitoringPointTriggerPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeMonitoringPointTriggerPermissionTreeResourceActionRequest", "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": "RegularAssetTypeMonitoringPointTrigger->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeMonitoringPointTriggerIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeMonitoringPointTriggerIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeMonitoringPointTriggerIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeMonitoringPointTriggerPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeMonitoringPointTriggerPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeMonitoringPointTriggerPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeOptionResourceActionResponse": { "title": "GetRegularAssetTypeOptionResourceActionResponse", "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": "GetRegularAssetTypeOptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeOption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeOption->ModifiedOn" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->AssetType_Description" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_LowerBounds" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UpperBounds" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_AllowMultipleValues" }, "optionOptionCategoryId": { "title": "optionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Id" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Description" }, "optionUnitOfMeasurementId": { "title": "optionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Id" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_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" } } }, "GetRegularAssetTypeOptionCollectionResourceActionResponse": { "title": "GetRegularAssetTypeOptionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeOptionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeOptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->AssetType_Description" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_Description" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Description" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_AllowMultipleValues" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeOption->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeOption->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" } } } }, "GetRegularAssetTypeOptionForAssetTypeCollectionResourceActionResponse": { "title": "GetRegularAssetTypeOptionForAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeOptionForAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeOptionForAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_Description" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Description" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_AllowMultipleValues" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "BatchGetRegularAssetTypeOptionResourceAction": { "title": "BatchGetRegularAssetTypeOptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Option entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeOptionResourceActionResponse" } }, "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" } } }, "GetRegularAssetTypeResponsibilityResourceActionResponse": { "title": "GetRegularAssetTypeResponsibilityResourceActionResponse", "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": "GetRegularAssetTypeResponsibilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeResponsibility->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeResponsibility->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeResponsibility->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->RegularAssetType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->InheritedFrom_Id" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->LastConfirmedChangeLogId" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Id", "x-NullExpression": "RegularAssetTypeResponsibility->Section_Id eq NULL AND RegularAssetTypeResponsibility->Trade_Id eq NULL" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_ContactDetailLastName" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_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" } } }, "GetRegularAssetTypeResponsibilityCollectionResourceActionResponse": { "title": "GetRegularAssetTypeResponsibilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeResponsibilityCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeResponsibilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->RegularAssetType_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->SequenceNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeResponsibility->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeResponsibility->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" } } } }, "GetRegularAssetTypeResponsibilityForRegularAssetTypeCollectionResourceActionResponse": { "title": "GetRegularAssetTypeResponsibilityForRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeResponsibilityForRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeResponsibilityForRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_ContactDetailLastName" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->IsInherited" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeResponsibilityChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeResponsibilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeResponsibilityRegularAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeResponsibilityRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeResponsibilityRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeResponsibilityRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeResponsibilityResourceLookupResourceActionResponse": { "title": "RegularAssetTypeResponsibilityResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeResponsibilityResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeResponsibilityResourceLookupResourceActionResponseItemProperties", "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" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Section_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" } } } }, "RegularAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse": { "title": "RegularAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeResponsibilityResourceWithTradeFilterLookupResourceActionResponseItemProperties", "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" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Resource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Section_Code" }, "idResourceTradeResourceTradeCode": { "title": "idResourceTradeResourceTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->*Id.ResourceTrade.Resource_Trade_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" } } } }, "RegularAssetTypeResponsibilitySectionLookupResourceActionResponse": { "title": "RegularAssetTypeResponsibilitySectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeResponsibilitySectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeResponsibilitySectionLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeResponsibilityTradeLookupResourceActionResponse": { "title": "RegularAssetTypeResponsibilityTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeResponsibilityTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeResponsibilityTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTypeResponsibilityResourceActionRequest": { "title": "CreateRegularAssetTypeResponsibilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeResponsibilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeId" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->RegularAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Id", "x-NullExpression": "RegularAssetTypeResponsibility->Section_Id eq NULL AND RegularAssetTypeResponsibility->Trade_Id eq NULL" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeResponsibilityResourceActionRequest": { "title": "UpdateRegularAssetTypeResponsibilityResourceActionRequest", "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": "RegularAssetTypeResponsibility->SequenceNumber" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeResponsibility->Resource_Id", "x-NullExpression": "RegularAssetTypeResponsibility->Section_Id eq NULL AND RegularAssetTypeResponsibility->Trade_Id eq NULL" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeResponsibility->Notes" } ] } } }, "BatchGetRegularAssetTypeResponsibilityResourceAction": { "title": "BatchGetRegularAssetTypeResponsibilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Responsibility entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Responsibility entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeResponsibilityResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeResponsibilityResourceActionRequest": { "title": "BatchCreateRegularAssetTypeResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeResponsibilityResourceActionRequest" } }, "BatchUpdateRegularAssetTypeResponsibilityResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeResponsibilityResourceActionRequest" } }, "ChangeRegularAssetTypeResponsibilityIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeResponsibilityIsActiveResourceActionRequest", "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": "RegularAssetTypeResponsibility->IsActive" } ] } } }, "ChangeRegularAssetTypeResponsibilityPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeResponsibilityPermissionTreeResourceActionRequest", "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": "RegularAssetTypeResponsibility->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeResponsibilityIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeResponsibilityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeResponsibilityIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeResponsibilityPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeResponsibilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeResponsibilityPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeRuleResourceActionResponse": { "title": "GetRegularAssetTypeRuleResourceActionResponse", "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": "GetRegularAssetTypeRuleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeRule->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeRule->ModifiedOn" }, "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->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" } } }, "GetRegularAssetTypeRuleCollectionResourceActionResponse": { "title": "GetRegularAssetTypeRuleCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeRuleCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeRuleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->SequenceNumber" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeRule->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeRule->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" } } } }, "GetRuleForRegularAssetTypeCollectionResourceActionResponse": { "title": "GetRuleForRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleForRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleForRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->RegularAssetType_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeRule->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeRule->SequenceNumber" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeRule->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeRule->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" } } } }, "BatchGetRegularAssetTypeRuleResourceAction": { "title": "BatchGetRegularAssetTypeRuleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Rule entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Rule entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeRuleResourceActionResponse" } }, "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" } } }, "GetRegularAssetTypeSpareResourceActionResponse": { "title": "GetRegularAssetTypeSpareResourceActionResponse", "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": "GetRegularAssetTypeSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeSpare->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->RegularAssetType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->InheritedFrom_Id" }, "inheritedFromMaterialMasterId": { "title": "inheritedFromMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Id" }, "inheritedFromMaterialMasterCode": { "title": "inheritedFromMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Code" }, "inheritedFromMaterialMasterDescription": { "title": "inheritedFromMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->InheritedFrom_MaterialMaster_Description" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsEmergency" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->IsHistorical" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "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" } } }, "GetRegularAssetTypeSpareCollectionResourceActionResponse": { "title": "GetRegularAssetTypeSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->RegularAssetType_Id" }, "regularAssetTypeCode": { "title": "regularAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->RegularAssetType_Code" }, "regularAssetTypeDescription": { "title": "regularAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->RegularAssetType_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetSpareForRegularAssetTypeCollectionResourceActionResponse": { "title": "GetSpareForRegularAssetTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForRegularAssetTypeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForRegularAssetTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeSpareChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeSpareMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetTypeSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeSpareRegularAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeSpareRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeSpareRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeSpareRegularAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeSpareResourceActionRequest": { "title": "CreateRegularAssetTypeSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeId", "materialMasterId", "isCritical", "isEmergency" ], "properties": { "regularAssetTypeId": { "title": "regularAssetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeSpare->RegularAssetType_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->PermissionTree_Id", "x-systemGenerated": true }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->MaterialMaster_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->SequenceNumber" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsEmergency" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeSpareResourceActionRequest": { "title": "UpdateRegularAssetTypeSpareResourceActionRequest", "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": "RegularAssetTypeSpare->SequenceNumber" }, { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsCritical" }, { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeSpare->IsEmergency" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeSpare->Notes" } ] } } }, "BatchGetRegularAssetTypeSpareResourceAction": { "title": "BatchGetRegularAssetTypeSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Spare entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeSpareResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeSpareResourceActionRequest": { "title": "BatchCreateRegularAssetTypeSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeSpareResourceActionRequest" } }, "BatchUpdateRegularAssetTypeSpareResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeSpareResourceActionRequest" } }, "ChangeRegularAssetTypeSpareIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeSpareIsActiveResourceActionRequest", "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": "RegularAssetTypeSpare->IsActive" } ] } } }, "ChangeRegularAssetTypeSparePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeSparePermissionTreeResourceActionRequest", "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": "RegularAssetTypeSpare->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeSpareIsActiveResourceActionResourceActionRequest": { "title": "BatchChangeRegularAssetTypeSpareIsActiveResourceActionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeSpareIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeSparePermissionTreeResourceActionResourceActionRequest": { "title": "BatchChangeRegularAssetTypeSparePermissionTreeResourceActionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeSparePermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeTaskResourceActionResponse": { "title": "GetRegularAssetTypeTaskResourceActionResponse", "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": "GetRegularAssetTypeTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTask->RulesLastChangedOn" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Description" }, "assetTypeNearestRegularAssetTypeId": { "title": "assetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_NearestRegularAssetType_Id" }, "assetTypeTreePathId": { "title": "assetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_TreePathId" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Description" }, "componentQuantity": { "title": "componentQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Quantity" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentTreePathId": { "title": "componentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_TreePathId" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->PermissionTree_Description" }, "allowConditions": { "title": "allowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AllowConditions" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AlternativeDescription" }, "autoCalculateDowntimePerUnit": { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateDowntimePerUnit" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateTotalDowntime" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateTotalDuration" }, "daysToScheduleOn": { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval2_Description" }, "derivedFromStandardTask": { "title": "derivedFromStandardTask", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->DerivedFromStandardTask" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->DurationPerUnit" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Event_Description" }, "excludeWhenAllFollowUpTaskRulesFail": { "title": "excludeWhenAllFollowUpTaskRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail" }, "excludeWhenAllSpareRulesFail": { "title": "excludeWhenAllSpareRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail" }, "excludeWhenSpecialResourceRulesFail": { "title": "excludeWhenSpecialResourceRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTypeTask->InspectionType eq 'PassOrFail'" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Importance_Id" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Importance_Code" }, "importanceDescription": { "title": "importanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Importance_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_Id" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_Description" }, "inheritedFromRecordType": { "title": "inheritedFromRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "inheritedFromAssetTypeId": { "title": "inheritedFromAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_AssetType_Id" }, "inheritedFromAssetTypeCode": { "title": "inheritedFromAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_AssetType_Code" }, "inheritedFromAssetTypeDescription": { "title": "inheritedFromAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_AssetType_Description" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTypeTask->IsInspection eq TRUE" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Id" }, "intervalType1SchedulingKind": { "title": "intervalType1SchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Description" }, "intervalType2SchedulingKind": { "title": "intervalType2SchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsDualScheduling" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsHistorical" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInspection" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsMandatory" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsNonUsageBasedReadingRequired" }, "isPausedForScheduling": { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsPausedForScheduling" }, "isStatutory": { "title": "isStatutory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsStatutory" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsSuppressed" }, "isSuppressor": { "title": "isSuppressor", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsSuppressor" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "longDescription": { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->LongDescription" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MachineState", "x-formatSpecifier": "MachineState" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_Id", "x-NullExpression": "RegularAssetTypeTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTypeTask->InspectionType eq 'ManualMonitoring'" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_Description" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Notes" }, "pausedReason": { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PausedReason", "x-NullExpression": "RegularAssetTypeTask->IsPausedForScheduling eq TRUE" }, "printLongDescriptionOnWorkOrder": { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleSection_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceContactDetailId": { "title": "responsibleStaffMemberResourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailId" }, "responsibleStaffMemberResourceContactDetailFirstName": { "title": "responsibleStaffMemberResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailFirstName" }, "responsibleStaffMemberResourceContactDetailLastName": { "title": "responsibleStaffMemberResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_ContactDetailLastName" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleTrade_Description" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Description" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskRollUpPoint_Description" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->TotalDuration" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->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" } } }, "GetRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AlternativeDescription" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SequenceNumber" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Description" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInspection" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsNonUsageBasedReadingRequired" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsMandatory" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Importance_Code" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTask->RulesLastChangedOn" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Description" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_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" } } } }, "StandardTaskAssetTypeComponentFromAssetTypeLookupResourceActionResponse": { "title": "StandardTaskAssetTypeComponentFromAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAssetTypeComponentFromAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAssetTypeComponentFromAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_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" } } } }, "StandardTaskAssetTypeComponentLookupResourceActionResponse": { "title": "StandardTaskAssetTypeComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAssetTypeComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAssetTypeComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->AssetType_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" } } } }, "StandardTaskAssetTypeLookupResourceActionResponse": { "title": "StandardTaskAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->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" } } } }, "RegularAssetTypeTaskAssetTypeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAssetTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetType->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetType->RecordType", "x-formatSpecifier": "AssetTypeRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskComponentLookupResourceActionResponse": { "title": "RegularAssetTypeTaskComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Description" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTypeComponent->RecordType", "x-formatSpecifier": "AssetTypeComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskDefaultInterval1AllLookupResourceActionResponse": { "title": "RegularAssetTypeTaskDefaultInterval1AllLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDefaultInterval1AllLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDefaultInterval1AllLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskDefaultInterval1LookupResourceActionResponse": { "title": "RegularAssetTypeTaskDefaultInterval1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDefaultInterval1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDefaultInterval1LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskDefaultInterval2AllLookupResourceActionResponse": { "title": "RegularAssetTypeTaskDefaultInterval2AllLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDefaultInterval2AllLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDefaultInterval2AllLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskDefaultInterval2LookupResourceActionResponse": { "title": "RegularAssetTypeTaskDefaultInterval2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDefaultInterval2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDefaultInterval2LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskEventLookupResourceActionResponse": { "title": "RegularAssetTypeTaskEventLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskEventLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskEventLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskImportanceLookupResourceActionResponse": { "title": "RegularAssetTypeTaskImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskImportanceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskIntervalType1LookupResourceActionResponse": { "title": "RegularAssetTypeTaskIntervalType1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskIntervalType1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskIntervalType1LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskIntervalType2LookupResourceActionResponse": { "title": "RegularAssetTypeTaskIntervalType2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskIntervalType2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskIntervalType2LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskMonitoringPointTypeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskMonitoringPointTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskMonitoringPointTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskMonitoringPointTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointType->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" } } } }, "RegularAssetTypeTaskResponsibleSectionLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResponsibleSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResponsibleSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResponsibleSectionLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResponsibleStaffMemberResourceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResponsibleTradeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResponsibleTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResponsibleTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResponsibleTradeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification1LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification1LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification2LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification2LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification3LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification3LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification3LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification3LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification4LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification4LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification4LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification4LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification5LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification5LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification5LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification5LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification6LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification6LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification6LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification6LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification7LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification7LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification7LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification7LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskClassification8LookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskClassification8LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskClassification8LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskClassification8LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTaskRollUpPointLookupResourceActionResponse": { "title": "RegularAssetTypeTaskTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskTypeOfWorkLookupResourceActionResponse": { "title": "RegularAssetTypeTaskTypeOfWorkLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskTypeOfWorkLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskTypeOfWorkLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTypeTaskResourceActionRequest": { "title": "CreateRegularAssetTypeTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetTypeId", "autoCalculateDowntimePerUnit", "autoCalculateTotalDowntime", "autoCalculateDurationPerUnit", "autoCalculateTotalDuration", "description", "importanceId", "intervalType1Id", "isDualScheduling", "isInspection", "isNonUsageBasedReadingRequired", "isMandatory", "isStatutory", "labourDurationCalculationType", "motionType", "printLongDescriptionOnWorkOrder", "typeOfWorkId" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AlternativeDescription", "x-systemGenerated": true }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "autoCalculateDowntimePerUnit": { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateDowntimePerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateTotalDowntime" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateTotalDuration" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code", "x-systemGenerated": true }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, "daysToScheduleOn": { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->DurationPerUnit" }, "excludeWhenAllFollowUpTaskRulesFail": { "title": "excludeWhenAllFollowUpTaskRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail" }, "excludeWhenSpecialResourceRulesFail": { "title": "excludeWhenSpecialResourceRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail" }, "excludeWhenAllSpareRulesFail": { "title": "excludeWhenAllSpareRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Event_Id" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTypeTask->InspectionType eq 'PassOrFail'" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Importance_Id" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Id" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsDualScheduling" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInspection" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTypeTask->IsInspection eq TRUE" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsNonUsageBasedReadingRequired" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsMandatory" }, "isStatutory": { "title": "isStatutory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsStatutory" }, "isPausedForScheduling": { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsPausedForScheduling" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "longDescription": { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->LongDescription" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_Id", "x-NullExpression": "RegularAssetTypeTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTypeTask->InspectionType eq 'ManualMonitoring'" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Notes" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MachineState", "x-formatSpecifier": "MachineState" }, "pausedReason": { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PausedReason", "x-NullExpression": "RegularAssetTypeTask->IsPausedForScheduling eq TRUE" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PermissionTree_Id", "x-systemGenerated": true }, "printLongDescriptionOnWorkOrder": { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_Id" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleSection_Id" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleTrade_Id" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SequenceNumber" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Id" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Id" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Id" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Id" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Id" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Id" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Id" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Id" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->TotalDuration" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TypeOfWork_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTask->TaskRollUpPoint_Id" }, "allowConditions": { "title": "allowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AllowConditions" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskResourceActionRequest", "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": "RegularAssetTypeTask->AlternativeDescription", "x-systemGenerated": true }, { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateDowntimePerUnit" }, { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateDurationPerUnit" }, { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateTotalDowntime" }, { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AutoCalculateTotalDuration" }, { "title": "code", "type": "string", "readOnly": true, "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code", "x-ReadOnlyExpression": "RegularAssetTypeTask->IsInherited eq true" }, { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description", "x-ReadOnlyExpression": "RegularAssetTypeTask->IsInherited eq true" }, { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->DowntimePerUnit" }, { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->DurationPerUnit" }, { "title": "excludeWhenAllFollowUpTaskRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenAllFollowUpTaskRulesFail" }, { "title": "excludeWhenSpecialResourceRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenSpecialResourceRulesFail" }, { "title": "excludeWhenAllSpareRulesFail", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->ExcludeWhenAllSpareRulesFail" }, { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Event_Id" }, { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTypeTask->InspectionType eq 'PassOrFail'" }, { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Importance_Id" }, { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Id" }, { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsDualScheduling" }, { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsInspection" }, { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTypeTask->IsInspection eq TRUE" }, { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsNonUsageBasedReadingRequired" }, { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsMandatory" }, { "title": "isStatutory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsStatutory" }, { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsPausedForScheduling" }, { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->LongDescription" }, { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MachineState", "x-formatSpecifier": "MachineState" }, { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_Id", "x-NullExpression": "RegularAssetTypeTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTypeTask->InspectionType eq 'ManualMonitoring'" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Notes" }, { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PausedReason", "x-NullExpression": "RegularAssetTypeTask->IsPausedForScheduling eq TRUE" }, { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PrintLongDescriptionOnWorkOrder" }, { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_Id" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleSection_Id" }, { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleTrade_Id" }, { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SequenceNumber" }, { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->TotalDowntime" }, { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTypeTask->TotalDuration" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TypeOfWork_Id" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTask->TaskRollUpPoint_Id" }, { "title": "allowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AllowConditions" } ] } } }, "BatchGetRegularAssetTypeTaskResourceAction": { "title": "BatchGetRegularAssetTypeTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskResourceActionRequest" } }, "ChangeRegularAssetTypeTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskIsActiveResourceActionRequest", "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": "RegularAssetTypeTask->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTask->PermissionTree_Id" } ] } } }, "CreateRegularAssetTypeTaskFromStandardTaskResourceActionRequest": { "title": "CreateRegularAssetTypeTaskFromStandardTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskFromStandardTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetTypeId", "standardTaskIds" ], "properties": { "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CreateRegularAssetTypeTaskFromStandardTask->AssetType_Id" }, "assetTypeComponentId": { "title": "assetTypeComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTypeTaskFromStandardTask->AssetTypeComponent_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTypeTaskFromStandardTask->PermissionTree_Id", "x-systemGenerated": true }, "breakStandardTaskLink": { "title": "breakStandardTaskLink", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTypeTaskFromStandardTask->BreakStandardTaskLink" }, "keepStandardTaskCode": { "title": "keepStandardTaskCode", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTypeTaskFromStandardTask->KeepStandardTaskCode" }, "standardTaskIds": { "title": "standardTaskIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "CreateRegularAssetTypeTaskFromStandardTask->StandardTaskIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeRegularAssetTypeTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskPermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTypeTaskResourceActionRequest": { "title": "MatchUpdateRegularAssetTypeTaskResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "allowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AllowConditions" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->AlternativeDescription" }, { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Importance_Id" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->TypeOfWork_Id" }, { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Event_Id" }, { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_Id" }, { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IntervalType2_Id", "x-NullExpression": "RegularAssetTypeTask->IsDualScheduling eq true" }, { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->IsDualScheduling" }, { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsMandatory" }, { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsPausedForScheduling" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->MachineState", "x-formatSpecifier": "MachineState" }, { "title": "isStatutory", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IsStatutory" }, { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->PausedReason", "x-NullExpression": "RegularAssetTypeTask->IsPausedForScheduling eq TRUE" }, { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleStaffMemberResource_Id" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleSection_Id" }, { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->ResponsibleTrade_Id" }, { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->SequenceNumber" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->TaskClassification8_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTask->TaskRollUpPoint_Id" } ] } } }, "GetRegularAssetTypeTaskAttributeResourceActionResponse": { "title": "GetRegularAssetTypeTaskAttributeResourceActionResponse", "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": "GetRegularAssetTypeTaskAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->InheritedFrom" }, "inheritedFromStandardTaskAttribute": { "title": "inheritedFromStandardTaskAttribute", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->InheritedFromStandardTaskAttribute" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->IsBackup" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRegularAssetTypeTaskAttributeCollectionForRegularAssetTypeTaskResourceActionResponse": { "title": "GetRegularAssetTypeTaskAttributeCollectionForRegularAssetTypeTaskResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskAttributeCollectionForRegularAssetTypeTaskResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskAttributeCollectionForRegularAssetTypeTaskResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_AllowAnyValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->ModifiedOn" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->LastConfirmedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTypeTaskAttributeCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAlternativeDescription": { "title": "regularAssetTypeTaskAlternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_AllowAnyValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAttribute->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" } } } }, "RegularAssetTypeTaskAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskAttributeAttributeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskAttributeRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAttributeRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAttributeRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAttributeRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_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" } } } }, "CreateRegularAssetTypeTaskAttributeResourceActionRequest": { "title": "CreateRegularAssetTypeTaskAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "attributeId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->RegularAssetTypeTask_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskAttributeResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAttribute->Notes" } ] } } }, "BatchGetRegularAssetTypeTaskAttributeResourceAction": { "title": "BatchGetRegularAssetTypeTaskAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Attribute entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskAttributeResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskAttributeResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskAttributeResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskAttributeResourceActionRequest" } }, "ChangeRegularAssetTypeTaskAttributeIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskAttributeIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskAttribute->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskAttributePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskAttributePermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAttributeIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAttributePermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeTaskAuxiliaryTaskResourceActionResponse": { "title": "GetRegularAssetTypeTaskAuxiliaryTaskResourceActionResponse", "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": "GetRegularAssetTypeTaskAuxiliaryTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->SequenceNumber" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id" }, "inheritedFromAuxiliaryTaskId": { "title": "inheritedFromAuxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Id" }, "inheritedFromAuxiliaryTaskCode": { "title": "inheritedFromAuxiliaryTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Code" }, "inheritedFromRegularAssetTypeTaskId": { "title": "inheritedFromRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Id" }, "inheritedFromRegularAssetTypeTaskCode": { "title": "inheritedFromRegularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->Notes" } } }, "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" } } }, "GetAuxiliaryTaskForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetAuxiliaryTaskForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryTaskForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryTaskForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTypeTaskAuxiliaryTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskAuxiliaryTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskAuxiliaryTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskAuxiliaryTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Description" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Description" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTypeTask->Description" }, "auxiliaryTaskType": { "title": "auxiliaryTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AuxiliaryTaskType", "x-formatSpecifier": "AuxiliaryTaskType" }, "assetTypeNearestRegularAssetTypeId": { "title": "assetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTypeTask->AssetType_NearestRegularAssetType_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" } } } }, "RegularAssetTypeTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskAuxiliaryTaskRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskAuxiliaryTaskRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskAuxiliaryTaskRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskAuxiliaryTaskRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "assetTypeNearestRegularAssetTypeId": { "title": "assetTypeNearestRegularAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_NearestRegularAssetType_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" } } } }, "CreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest": { "title": "CreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "auxiliaryTaskId", "auxiliaryType" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->RegularAssetTypeTask_Id" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id", "x-systemGenerated": true }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest", "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": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskAuxiliaryTask->Notes" } ] } } }, "BatchGetRegularAssetTypeTaskAuxiliaryTaskResourceAction": { "title": "BatchGetRegularAssetTypeTaskAuxiliaryTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Auxiliary Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Auxiliary Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskAuxiliaryTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskAuxiliaryTaskResourceActionRequest" } }, "ChangeRegularAssetTypeTaskAuxiliaryTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskAuxiliaryTaskIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskAuxiliaryTask->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskAuxiliaryTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskAuxiliaryTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskAuxiliaryTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAuxiliaryTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskAuxiliaryTaskPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeTaskConditionResourceActionResponse": { "title": "GetRegularAssetTypeTaskConditionResourceActionResponse", "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": "GetRegularAssetTypeTaskConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskCondition->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskIntervalType1Id": { "title": "regularAssetTypeTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskId": { "title": "inheritedFromRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->InheritedFrom_RegularAssetTypeTask_Id" }, "inheritedFromRegularAssetTypeTaskCode": { "title": "inheritedFromRegularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->InheritedFrom_RegularAssetTypeTask_Code" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Id" }, "intervalCode": { "title": "intervalCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Code" }, "intervalDescription": { "title": "intervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Notes" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->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" } } }, "GetRegularAssetTypeTaskConditionCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskIntervalType1Id": { "title": "regularAssetTypeTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Id" }, "intervalCode": { "title": "intervalCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Code" }, "intervalDescription": { "title": "intervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->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" } } } }, "GetRegularAssetTypeTaskConditionForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskConditionForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskConditionForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskConditionForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_ConditionType_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->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" } } } }, "GetRegularAssetTypeTaskConditionsRecursiveForParentResourceActionResponse": { "title": "GetRegularAssetTypeTaskConditionsRecursiveForParentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskConditionsRecursiveForParentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskConditionsRecursiveForParentResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskAssetTypeTreePathItems": { "title": "regularAssetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Id" }, "regularAssetTypeTaskComponentCode": { "title": "regularAssetTypeTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Code" }, "regularAssetTypeTaskComponentDescription": { "title": "regularAssetTypeTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_Description" }, "regularAssetTypeTaskComponentTreePathItems": { "title": "regularAssetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTypeTaskVersion": { "title": "regularAssetTypeTaskVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Version" }, "regularAssetTypeTaskPermissionTreeId": { "title": "regularAssetTypeTaskPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_PermissionTree_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskIntervalType1Id": { "title": "regularAssetTypeTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Id" }, "regularAssetTypeTaskIntervalType1Code": { "title": "regularAssetTypeTaskIntervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType1_Code" }, "regularAssetTypeTaskIntervalType2Code": { "title": "regularAssetTypeTaskIntervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_IntervalType2_Code" }, "regularAssetTypeTaskAllowConditions": { "title": "regularAssetTypeTaskAllowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_AllowConditions" }, "regularAssetTypeTaskMotionType": { "title": "regularAssetTypeTaskMotionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_MotionType", "x-formatSpecifier": "MotionType" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_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" } } } }, "RegularAssetTypeTaskConditionAllTaskIntervalLookupResourceActionResponse": { "title": "RegularAssetTypeTaskConditionAllTaskIntervalLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskConditionAllTaskIntervalLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskConditionAllTaskIntervalLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskConditionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskConditionRegularAssetTypeConditionLookupResourceActionResponse": { "title": "RegularAssetTypeTaskConditionRegularAssetTypeConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskConditionRegularAssetTypeConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskConditionRegularAssetTypeConditionLookupResourceActionResponseItemProperties", "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" }, "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" } } } }, "RegularAssetTypeTaskConditionRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskConditionRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskConditionRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskConditionRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->IntervalType1_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" } } } }, "RegularAssetTypeTaskConditionTaskIntervalLookupResourceActionResponse": { "title": "RegularAssetTypeTaskConditionTaskIntervalLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskConditionTaskIntervalLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskConditionTaskIntervalLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTypeTaskConditionResourceActionRequest": { "title": "CreateRegularAssetTypeTaskConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "conditionId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskCondition->RegularAssetTypeTask_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Condition_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskCondition->PermissionTree_Id", "x-systemGenerated": true }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->State", "x-systemGenerated": true, "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor", "x-systemGenerated": true }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskConditionResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskConditionResourceActionRequest", "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": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor" }, { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Notes" } ] } } }, "BatchGetRegularAssetTypeTaskConditionResourceAction": { "title": "BatchGetRegularAssetTypeTaskConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Condition entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskConditionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskConditionResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskConditionResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskConditionResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskConditionResourceActionRequest" } }, "ChangeRegularAssetTypeTaskConditionIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskConditionIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskCondition->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskConditionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskConditionPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskCondition->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskConditionIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskConditionIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskConditionPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskConditionPermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTypeTaskConditionResourceActionRequest": { "title": "MatchUpdateRegularAssetTypeTaskConditionResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->AdjustmentFactor" }, { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Interval_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskCondition->Notes" } ] } } }, "GetRegularAssetTypeTaskDocumentResourceActionResponse": { "title": "GetRegularAssetTypeTaskDocumentResourceActionResponse", "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": "GetRegularAssetTypeTaskDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->RegularAssetTypeTask_Description" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->InheritedFrom" }, "inheritedFromStandardTaskDocument": { "title": "inheritedFromStandardTaskDocument", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->InheritedFromStandardTaskDocument" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskDocument->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->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" } } }, "GetRegularAssetTypeTaskDocumentCollectionForRegularAssetTypeTaskResourceActionResponse": { "title": "GetRegularAssetTypeTaskDocumentCollectionForRegularAssetTypeTaskResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskDocumentCollectionForRegularAssetTypeTaskResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskDocumentCollectionForRegularAssetTypeTaskResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->Notes" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskDocument->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" } } } }, "GetRegularAssetTypeTaskDocumentCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->RegularAssetTypeTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_FileType_Extension" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskDocument->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" } } } }, "RegularAssetTypeTaskDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskDocumentDocumentLookupResourceActionResponse": { "title": "RegularAssetTypeTaskDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskDocumentRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskDocumentRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskDocumentRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskDocumentRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->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" } } } }, "CreateRegularAssetTypeTaskDocumentResourceActionRequest": { "title": "CreateRegularAssetTypeTaskDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "documentRecordId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->RegularAssetTypeTask_Id" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskDocumentResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskDocumentResourceActionRequest", "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": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskDocument->Notes" } ] } } }, "DeleteRegularAssetTypeTaskDocumentResourceActionRequest": { "title": "DeleteRegularAssetTypeTaskDocumentResourceActionRequest", "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 } } }, "BatchGetRegularAssetTypeTaskDocumentResourceAction": { "title": "BatchGetRegularAssetTypeTaskDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Document entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskDocumentResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskDocumentResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskDocumentResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskDocumentResourceActionRequest" } }, "BatchDeleteRegularAssetTypeTaskDocumentResourceActionRequest": { "title": "BatchDeleteRegularAssetTypeTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTypeTaskDocumentResourceActionRequest" } }, "ChangeRegularAssetTypeTaskDocumentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskDocumentIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskDocument->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskDocumentPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskDocument->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskDocumentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskDocumentPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeTaskFollowUpTaskResourceActionResponse": { "title": "GetRegularAssetTypeTaskFollowUpTaskResourceActionResponse", "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": "GetRegularAssetTypeTaskFollowUpTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskMonitoringPointTypeId": { "title": "regularAssetTypeTaskMonitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_Id" }, "regularAssetTypeTaskMonitoringPointTypeHasUpperCriticalBound": { "title": "regularAssetTypeTaskMonitoringPointTypeHasUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasUpperCriticalBound" }, "regularAssetTypeTaskMonitoringPointTypeHasUpperWarningBound": { "title": "regularAssetTypeTaskMonitoringPointTypeHasUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasUpperWarningBound" }, "regularAssetTypeTaskMonitoringPointTypeHasLowerCriticalBound": { "title": "regularAssetTypeTaskMonitoringPointTypeHasLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasLowerCriticalBound" }, "regularAssetTypeTaskMonitoringPointTypeHasLowerWarningBound": { "title": "regularAssetTypeTaskMonitoringPointTypeHasLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_MonitoringPointType_HasLowerWarningBound" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->SequenceNumber" }, "addToWorkOrder": { "title": "addToWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->AddToWorkOrder" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->Notes" }, "triggerWhenLowerCriticalBound": { "title": "triggerWhenLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound" }, "triggerWhenLowerWarningBound": { "title": "triggerWhenLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound" }, "triggerWhenUpperCriticalBound": { "title": "triggerWhenUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound" }, "triggerWhenUpperWarningBound": { "title": "triggerWhenUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound" } } }, "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" } } }, "GetRegularAssetTypeTaskFollowUpTaskForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskFollowUpTaskForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskFollowUpTaskForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskFollowUpTaskForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->InheritedFrom_LastConfirmedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->SequenceNumber" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->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" } } } }, "GetRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->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" } } } }, "RegularAssetTypeTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskFollowUpTaskFollowUpTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskFollowUpTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskFollowUpTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskFollowUpTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->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" } } } }, "RegularAssetTypeTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_Id" }, "monitoringPointTypeHasUpperCriticalBound": { "title": "monitoringPointTypeHasUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_HasUpperCriticalBound" }, "monitoringPointTypeHasUpperWarningBound": { "title": "monitoringPointTypeHasUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_HasUpperWarningBound" }, "monitoringPointTypeHasLowerCriticalBound": { "title": "monitoringPointTypeHasLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_HasLowerCriticalBound" }, "monitoringPointTypeHasLowerWarningBound": { "title": "monitoringPointTypeHasLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->MonitoringPointType_HasLowerWarningBound" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeTaskFollowUpTaskResourceActionRequest": { "title": "CreateRegularAssetTypeTaskFollowUpTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskFollowUpTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "followUpTaskId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Id" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->PermissionTree_Id", "x-systemGenerated": true }, "addToWorkOrder": { "title": "addToWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->AddToWorkOrder" }, "triggerWhenLowerCriticalBound": { "title": "triggerWhenLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound" }, "triggerWhenLowerWarningBound": { "title": "triggerWhenLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound" }, "triggerWhenUpperCriticalBound": { "title": "triggerWhenUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound" }, "triggerWhenUpperWarningBound": { "title": "triggerWhenUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskFollowUpTaskResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskFollowUpTaskResourceActionRequest", "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": "followUpTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Id" }, { "title": "addToWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->AddToWorkOrder" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->SequenceNumber" }, { "title": "triggerWhenLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerCriticalBound" }, { "title": "triggerWhenLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenLowerWarningBound" }, { "title": "triggerWhenUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperCriticalBound" }, { "title": "triggerWhenUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->TriggerWhenUpperWarningBound" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->Notes" } ] } } }, "BatchGetRegularAssetTypeTaskFollowUpTaskResourceAction": { "title": "BatchGetRegularAssetTypeTaskFollowUpTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Follow Up Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Follow Up Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskFollowUpTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskFollowUpTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskFollowUpTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskFollowUpTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskFollowUpTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskFollowUpTaskResourceActionRequest" } }, "ChangeRegularAssetTypeTaskFollowUpTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskFollowUpTaskIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskFollowUpTask->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskFollowUpTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskFollowUpTaskPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskFollowUpTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskFollowUpTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskFollowUpTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskFollowUpTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskFollowUpTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeTaskFollowUpTaskExpressionResourceActionResponse": { "title": "GetRegularAssetTypeTaskFollowUpTaskExpressionResourceActionResponse", "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": "GetRegularAssetTypeTaskFollowUpTaskExpressionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->InheritedFrom_Id" }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionExpression", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Expression" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->Notes" }, "regularAssetTypeTaskFollowUpTaskId": { "title": "regularAssetTypeTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id" }, "regularAssetTypeTaskFollowUpTaskFollowUpTaskId": { "title": "regularAssetTypeTaskFollowUpTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Id" }, "regularAssetTypeTaskFollowUpTaskFollowUpTaskCode": { "title": "regularAssetTypeTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code" }, "regularAssetTypeTaskFollowUpTaskFollowUpTaskDescription": { "title": "regularAssetTypeTaskFollowUpTaskFollowUpTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Description" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Description" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskInspectionType": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskInspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_InspectionType", "x-formatSpecifier": "InspectionType" } } }, "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" } } }, "GetRegularAssetTypeTaskFollowUpTaskExpressionCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskFollowUpTaskExpressionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskFollowUpTaskExpressionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskFollowUpTaskExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->IsInherited" }, "inheritedFromRegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode": { "title": "inheritedFromRegularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->InheritedFrom_RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskFollowUpTaskId": { "title": "regularAssetTypeTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskInspectionType": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskInspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTypeTask->IsInspection eq TRUE" }, "regularAssetTypeTaskFollowUpTaskFollowUpTaskCode": { "title": "regularAssetTypeTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description" }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->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" } } } }, "GetRegularAssetTypeTaskFollowUpTaskExpressionForRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskFollowUpTaskExpressionForRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskFollowUpTaskExpressionForRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskFollowUpTaskExpressionForRegularAssetTypeTaskFollowUpTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->InheritedFrom_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber" }, "regularAssetTypeTaskFollowUpTaskId": { "title": "regularAssetTypeTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id" }, "regularAssetTypeTaskFollowUpTaskFollowUpTaskCode": { "title": "regularAssetTypeTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code" }, "regularAssetTypeTaskFollowUpTaskFollowUpTaskDescription": { "title": "regularAssetTypeTaskFollowUpTaskFollowUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_FollowUpTask_Description" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskFollowUpTaskRegularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_RegularAssetTypeTask_Description" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->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" } } } }, "RegularAssetTypeTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskFollowUpTaskExpressionFollowUpTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionFollowUpTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionFollowUpTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionFollowUpTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->FollowUpTask_Description" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskInspectionType": { "title": "regularAssetTypeTaskInspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTask->RegularAssetTypeTask_InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTypeTask->IsInspection eq TRUE" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskFollowUpTaskMPTExpressionLookupResourceActionResponse": { "title": "RegularAssetTypeTaskFollowUpTaskMPTExpressionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskFollowUpTaskMPTExpressionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskFollowUpTaskMPTExpressionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Expression" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest": { "title": "CreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskFollowUpTaskId", "monitoringPointTriggerExpressionId" ], "properties": { "regularAssetTypeTaskFollowUpTaskId": { "title": "regularAssetTypeTaskFollowUpTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->RegularAssetTypeTaskFollowUpTask_Id" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Id", "x-systemGenerated": true }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest", "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": "RegularAssetTypeTaskFollowUpTaskExpression->SequenceNumber" }, { "title": "manualReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->ManualReadingRequired" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskFollowUpTaskExpression->Notes" } ] } } }, "BatchGetRegularAssetTypeTaskFollowUpTaskExpressionResourceAction": { "title": "BatchGetRegularAssetTypeTaskFollowUpTaskExpressionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Follow Up Task Expression entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Follow Up Task Expression entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskFollowUpTaskExpressionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskFollowUpTaskExpressionResourceActionRequest" } }, "ChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskFollowUpTaskExpression->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskFollowUpTaskExpression->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskExpressionIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeTaskResourceResourceActionResponse": { "title": "GetRegularAssetTypeTaskResourceResourceActionResponse", "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": "GetRegularAssetTypeTaskResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResource->RulesLastChangedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResource->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->SequenceNumber" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskId": { "title": "inheritedFromRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->InheritedFrom_RegularAssetTypeTask_Id" }, "inheritedFromRegularAssetTypeTaskRecordType": { "title": "inheritedFromRegularAssetTypeTaskRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->InheritedFrom_RegularAssetTypeTask_RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->IsHistorical" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Description" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->UnitOfMeasurement_Description" }, "unitOfMeasurementMeasurementType": { "title": "unitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->UnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskResource->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" } } }, "GetRegularAssetTypeTaskResourceCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskResourceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskResourceCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->IsActive" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeTreePathItems": { "title": "regularAssetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTypeTaskComponentTreePathItems": { "title": "regularAssetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->SequenceNumber" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Description" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Description" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResource->RulesLastChangedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTypeTaskResourceForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskResourceForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskResourceForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskResourceForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->SequenceNumber" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceCompetencyLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceCompetencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceCompetencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceCompetencyLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceFilterByTradeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceFilterByTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceFilterByTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceFilterByTradeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->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" } } } }, "RegularAssetTypeTaskResourceResourceLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->Description" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskResourceSectionLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceSectionLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceTradeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceTradeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTypeTaskResourceResourceActionRequest": { "title": "CreateRegularAssetTypeTaskResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "quantity", "tradeId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Id" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Id" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTypeTaskResource->Usage", "x-systemGenerated": true, "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->PermissionTree_Id", "x-systemGenerated": true }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskResource->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Id" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ResourceType", "x-systemGenerated": true, "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->UnitOfMeasurement_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskResourceResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskResourceResourceActionRequest", "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": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Notes" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Id" }, { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Id" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Proficiency" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskResource->Quantity" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->UnitOfMeasurement_Id" } ] } } }, "BatchGetRegularAssetTypeTaskResourceResourceAction": { "title": "BatchGetRegularAssetTypeTaskResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Resource entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskResourceResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskResourceResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskResourceResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskResourceResourceActionRequest" } }, "ChangeRegularAssetTypeTaskResourceIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskResourceIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskResource->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskResourcePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskResourcePermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskResource->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskResourceIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskResourceIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskResourcePermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTypeTaskResourceResourceActionRequest": { "title": "MatchUpdateRegularAssetTypeTaskResourceResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskResource->Quantity" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Id" }, { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Id" }, { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Competency_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->UnitOfMeasurement_Id" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->SequenceNumber" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Proficiency" } ] } } }, "GetRegularAssetTypeTaskResourceRuleLinkResourceActionResponse": { "title": "GetRegularAssetTypeTaskResourceRuleLinkResourceActionResponse", "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": "GetRegularAssetTypeTaskResourceRuleLinkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->ModifiedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskResourceId": { "title": "inheritedFromRegularAssetTypeTaskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_RegularAssetTypeTaskResource_Id" }, "inheritedFromRuleId": { "title": "inheritedFromRuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Id" }, "inheritedFromRuleCode": { "title": "inheritedFromRuleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Code" }, "inheritedFromRuleDescription": { "title": "inheritedFromRuleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_Description" }, "inheritedFromRuleRuleCategoryId": { "title": "inheritedFromRuleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Id" }, "inheritedFromRuleRuleCategoryCode": { "title": "inheritedFromRuleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Code" }, "inheritedFromRuleRuleCategoryDescription": { "title": "inheritedFromRuleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->InheritedFrom_Rule_RuleCategory_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Notes" }, "regularAssetTypeTaskResourceId": { "title": "regularAssetTypeTaskResourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Description" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskResourceResourceId": { "title": "regularAssetTypeTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Id" }, "regularAssetTypeTaskResourceResourceCode": { "title": "regularAssetTypeTaskResourceResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code" }, "regularAssetTypeTaskResourceResourceDescription": { "title": "regularAssetTypeTaskResourceResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_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" } } }, "GetRegularAssetTypeTaskResourceRuleLinkCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskResourceRuleLinkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskResourceRuleLinkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskResourceRuleLinkCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskResourceId": { "title": "regularAssetTypeTaskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Description" }, "regularAssetTypeTaskResourceResourceId": { "title": "regularAssetTypeTaskResourceResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Id" }, "regularAssetTypeTaskResourceResourceCode": { "title": "regularAssetTypeTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code" }, "regularAssetTypeTaskResourceResourceDescription": { "title": "regularAssetTypeTaskResourceResourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->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" } } } }, "GetRuleLinkForRegularAssetTypeTaskResourceCollectionResourceActionResponse": { "title": "GetRuleLinkForRegularAssetTypeTaskResourceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleLinkForRegularAssetTypeTaskResourceCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleLinkForRegularAssetTypeTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskResourceId": { "title": "regularAssetTypeTaskResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskResourceRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskResourceRegularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_RegularAssetTypeTask_Description" }, "regularAssetTypeTaskResourceResourceCode": { "title": "regularAssetTypeTaskResourceResourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Resource_Code" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskResourceRuleLinkTaskRegularAssetTypeTaskResourceLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceRuleLinkTaskRegularAssetTypeTaskResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceRuleLinkTaskRegularAssetTypeTaskResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceRuleLinkTaskRegularAssetTypeTaskResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Resource_Code" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Trade_Code" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->Section_Code" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResource->RegularAssetTypeTask_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" } } } }, "RegularAssetTypeTaskResourceRuleLinkRuleLookupResourceActionResponse": { "title": "RegularAssetTypeTaskResourceRuleLinkRuleLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskResourceRuleLinkRuleLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskResourceRuleLinkRuleLookupResourceActionResponseItemProperties", "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" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest": { "title": "CreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskResourceId", "ruleId" ], "properties": { "regularAssetTypeTaskResourceId": { "title": "regularAssetTypeTaskResourceId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->RegularAssetTypeTaskResource_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Rule_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest", "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": "RegularAssetTypeTaskResourceRuleLink->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskResourceRuleLink->SequenceNumber" } ] } } }, "BatchGetRegularAssetTypeTaskResourceRuleLinkResourceAction": { "title": "BatchGetRegularAssetTypeTaskResourceRuleLinkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Resource Rule Link entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Resource Rule Link entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskResourceRuleLinkResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskResourceRuleLinkResourceActionRequest" } }, "ChangeRegularAssetTypeTaskResourceRuleLinkIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskResourceRuleLinkIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskResourceRuleLink->IsActive" } ] } } }, "BatchChangeRegularAssetTypeTaskResourceRuleLinkIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskResourceRuleLinkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskResourceRuleLinkIsActiveResourceActionRequest" } }, "GetRegularAssetTypeTaskRuleLinkResourceActionResponse": { "title": "GetRegularAssetTypeTaskRuleLinkResourceActionResponse", "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": "GetRegularAssetTypeTaskRuleLinkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskRuleLink->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskRuleLink->ModifiedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskRuleLink->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Id" }, "regularAssetTypeTaskComponentCode": { "title": "regularAssetTypeTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Code" }, "regularAssetTypeTaskComponentDescription": { "title": "regularAssetTypeTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->SequenceNumber" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskId": { "title": "inheritedFromRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Id" }, "inheritedFromRegularAssetTypeTaskCode": { "title": "inheritedFromRegularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Code" }, "inheritedFromRegularAssetTypeTaskDescription": { "title": "inheritedFromRegularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_Description" }, "inheritedFromRegularAssetTypeTaskAssetTypeId": { "title": "inheritedFromRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Id" }, "inheritedFromRegularAssetTypeTaskAssetTypeCode": { "title": "inheritedFromRegularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Code" }, "inheritedFromRegularAssetTypeTaskAssetTypeDescription": { "title": "inheritedFromRegularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_RegularAssetTypeTask_AssetType_Description" }, "inheritedFromRuleId": { "title": "inheritedFromRuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Id" }, "inheritedFromRuleCode": { "title": "inheritedFromRuleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Code" }, "inheritedFromRuleDescription": { "title": "inheritedFromRuleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_Description" }, "inheritedFromRuleRuleCategoryId": { "title": "inheritedFromRuleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Id" }, "inheritedFromRuleRuleCategoryCode": { "title": "inheritedFromRuleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Code" }, "inheritedFromRuleRuleCategoryDescription": { "title": "inheritedFromRuleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->InheritedFrom_Rule_RuleCategory_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Notes" } } }, "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" } } }, "GetRegularAssetTypeTaskRuleLinkCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskRuleLinkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskRuleLinkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskRuleLinkCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskComponentId": { "title": "regularAssetTypeTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Id" }, "regularAssetTypeTaskComponentCode": { "title": "regularAssetTypeTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Code" }, "regularAssetTypeTaskComponentDescription": { "title": "regularAssetTypeTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Component_Description" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->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" } } } }, "GetRuleLinkForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetRuleLinkForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleLinkForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleLinkForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskRuleLinkTaskRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskRuleLinkTaskRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskRuleLinkTaskRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskRuleLinkTaskRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->AssetType_Description" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTask->Component_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskRuleLinkRuleLookupResourceActionResponse": { "title": "RegularAssetTypeTaskRuleLinkRuleLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskRuleLinkRuleLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskRuleLinkRuleLookupResourceActionResponseItemProperties", "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" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeTaskRuleLinkResourceActionRequest": { "title": "CreateRegularAssetTypeTaskRuleLinkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskRuleLinkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "ruleId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->RegularAssetTypeTask_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Rule_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskRuleLinkResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskRuleLinkResourceActionRequest", "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": "RegularAssetTypeTaskRuleLink->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskRuleLink->SequenceNumber" } ] } } }, "BatchGetRegularAssetTypeTaskRuleLinkResourceAction": { "title": "BatchGetRegularAssetTypeTaskRuleLinkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Rule Link entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Rule Link entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskRuleLinkResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskRuleLinkResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskRuleLinkResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskRuleLinkResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskRuleLinkResourceActionRequest" } }, "ChangeRegularAssetTypeTaskRuleLinkIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskRuleLinkIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskRuleLink->IsActive" } ] } } }, "BatchChangeRegularAssetTypeTaskRuleLinkIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskRuleLinkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskRuleLinkIsActiveResourceActionRequest" } }, "GetRegularAssetTypeTaskSpareResourceActionResponse": { "title": "GetRegularAssetTypeTaskSpareResourceActionResponse", "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": "GetRegularAssetTypeTaskSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpare->RulesLastChangedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpare->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->SequenceNumber" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskId": { "title": "inheritedFromRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->InheritedFrom_RegularAssetTypeTask_Id" }, "inheritedFromRegularAssetTypeTaskRecordType": { "title": "inheritedFromRegularAssetTypeTaskRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->InheritedFrom_RegularAssetTypeTask_RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->IsHistorical" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->Notes" }, "preferredMaterialMasterId": { "title": "preferredMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id" }, "preferredMaterialMasterCode": { "title": "preferredMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PreferredMaterialMaster_Code" }, "preferredMaterialMasterDescription": { "title": "preferredMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PreferredMaterialMaster_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" } } }, "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" } } }, "GetRegularAssetTypeTaskSpareCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Description" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Description" }, "regularAssetTypeTaskAssetTypeTreePathItems": { "title": "regularAssetTypeTaskAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTypeTaskComponentTreePathItems": { "title": "regularAssetTypeTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "rulesLastChangedOn": { "title": "rulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpare->RulesLastChangedOn" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->Quantity" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->InheritedFrom_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" } } } }, "GetSpareForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetSpareForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Commodity_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->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" } } } }, "RegularAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSpareCommodityLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareCommodityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareCommodityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareCommodityLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSpareCostElementLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSpareMaterialMasterForCommodityLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareMaterialMasterForCommodityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareMaterialMasterForCommodityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareMaterialMasterForCommodityLookupResourceActionResponseItemProperties", "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" }, "commodityId": { "title": "commodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MaterialMaster->Commodity_Id" }, "commodityCode": { "title": "commodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Code" }, "commodityDescription": { "title": "commodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->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" } } } }, "RegularAssetTypeTaskSpareMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" }, "commodityId": { "title": "commodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MaterialMaster->Commodity_Id" }, "commodityCode": { "title": "commodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Code" }, "commodityDescription": { "title": "commodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->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" } } } }, "RegularAssetTypeTaskSpareTaskRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareTaskRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareTaskRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareTaskRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->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" } } } }, "RegularAssetTypeTaskSpareWithMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareWithMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareWithMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareWithMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTypeTaskSpareResourceActionRequest": { "title": "CreateRegularAssetTypeTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "materialMasterId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->PermissionTree_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSpare->Quantity" }, "preferredMaterialMasterId": { "title": "preferredMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskSpareResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskSpareResourceActionRequest", "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": "RegularAssetTypeTaskSpare->CostElement_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->Notes" }, { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSpare->Quantity" }, { "title": "preferredMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->PreferredMaterialMaster_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->SequenceNumber" } ] } } }, "BatchGetRegularAssetTypeTaskSpareResourceAction": { "title": "BatchGetRegularAssetTypeTaskSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Spare entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskSpareResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskSpareResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskSpareResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskSpareResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSpareResourceActionRequest" } }, "ChangeRegularAssetTypeTaskSpareIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskSpareIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskSpare->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskSparePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskSparePermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskSpare->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskSpareIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSpareIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskSparePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSparePermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTypeTaskSpareResourceActionRequest": { "title": "MatchUpdateRegularAssetTypeTaskSpareResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSpare->Quantity" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->CostElement_Id" } ] } } }, "GetRegularAssetTypeTaskSpareRuleLinkResourceActionResponse": { "title": "GetRegularAssetTypeTaskSpareRuleLinkResourceActionResponse", "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": "GetRegularAssetTypeTaskSpareRuleLinkResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Description" }, "ruleRuleText": { "title": "ruleRuleText", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleText" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->SequenceNumber" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->ModifiedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskSpareId": { "title": "inheritedFromRegularAssetTypeTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_RegularAssetTypeTaskSpare_Id" }, "inheritedFromRuleId": { "title": "inheritedFromRuleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Id" }, "inheritedFromRuleCode": { "title": "inheritedFromRuleCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Code" }, "inheritedFromRuleDescription": { "title": "inheritedFromRuleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_Description" }, "inheritedFromRuleRuleCategoryId": { "title": "inheritedFromRuleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Id" }, "inheritedFromRuleRuleCategoryCode": { "title": "inheritedFromRuleRuleCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Code" }, "inheritedFromRuleRuleCategoryDescription": { "title": "inheritedFromRuleRuleCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->InheritedFrom_Rule_RuleCategory_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Notes" }, "regularAssetTypeTaskSpareId": { "title": "regularAssetTypeTaskSpareId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id" }, "regularAssetTypeTaskSpareMaterialMasterId": { "title": "regularAssetTypeTaskSpareMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Id" }, "regularAssetTypeTaskSpareMaterialMasterCode": { "title": "regularAssetTypeTaskSpareMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Code" }, "regularAssetTypeTaskSpareMaterialMasterDescription": { "title": "regularAssetTypeTaskSpareMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Description" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Description" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_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" } } }, "GetRegularAssetTypeTaskSpareRuleLinkCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskSpareRuleLinkCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskSpareRuleLinkCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskSpareRuleLinkCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskSpareId": { "title": "regularAssetTypeTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Description" }, "regularAssetTypeTaskSpareMaterialMasterCode": { "title": "regularAssetTypeTaskSpareMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Code" }, "regularAssetTypeTaskSpareMaterialMasterDescription": { "title": "regularAssetTypeTaskSpareMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Description" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->IsActive" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->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" } } } }, "GetRuleLinkForRegularAssetTypeTaskSpareCollectionResourceActionResponse": { "title": "GetRuleLinkForRegularAssetTypeTaskSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRuleLinkForRegularAssetTypeTaskSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRuleLinkForRegularAssetTypeTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTypeTaskSpareId": { "title": "regularAssetTypeTaskSpareId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskCode": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Code" }, "regularAssetTypeTaskSpareRegularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskSpareRegularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_RegularAssetTypeTask_Description" }, "regularAssetTypeTaskSpareMaterialMasterCommodityCode": { "title": "regularAssetTypeTaskSpareMaterialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Commodity_Code" }, "regularAssetTypeTaskSpareMaterialMasterCommodityDescription": { "title": "regularAssetTypeTaskSpareMaterialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_MaterialMaster_Commodity_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->IsInherited" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Id" }, "ruleCode": { "title": "ruleCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Code" }, "ruleDescription": { "title": "ruleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Description" }, "ruleRuleCategoryId": { "title": "ruleRuleCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Id" }, "ruleRuleCategoryCode": { "title": "ruleRuleCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Code" }, "ruleRuleCategoryDescription": { "title": "ruleRuleCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_RuleCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->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" } } } }, "RegularAssetTypeTaskSpareRuleLinkTaskRegularAssetTypeTaskSpareLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareRuleLinkTaskRegularAssetTypeTaskSpareLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareRuleLinkTaskRegularAssetTypeTaskSpareLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareRuleLinkTaskRegularAssetTypeTaskSpareLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->MaterialMaster_Description" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskAssetTypeId": { "title": "regularAssetTypeTaskAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Id" }, "regularAssetTypeTaskAssetTypeCode": { "title": "regularAssetTypeTaskAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Code" }, "regularAssetTypeTaskAssetTypeDescription": { "title": "regularAssetTypeTaskAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_AssetType_Description" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpare->RegularAssetTypeTask_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" } } } }, "RegularAssetTypeTaskSpareRuleLinkRuleLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSpareRuleLinkRuleLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSpareRuleLinkRuleLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSpareRuleLinkRuleLookupResourceActionResponseItemProperties", "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" }, "ruleText": { "title": "ruleText", "type": "string", "x-nullable": false, "x-propertyPath": "Rule->RuleText" }, "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" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest": { "title": "CreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskSpareId", "ruleId" ], "properties": { "regularAssetTypeTaskSpareId": { "title": "regularAssetTypeTaskSpareId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->RegularAssetTypeTaskSpare_Id" }, "ruleId": { "title": "ruleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Rule_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest", "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": "RegularAssetTypeTaskSpareRuleLink->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSpareRuleLink->SequenceNumber" } ] } } }, "BatchGetRegularAssetTypeTaskSpareRuleLinkResourceAction": { "title": "BatchGetRegularAssetTypeTaskSpareRuleLinkResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Spare Rule Link entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Spare Rule Link entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskSpareRuleLinkResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSpareRuleLinkResourceActionRequest" } }, "ChangeRegularAssetTypeTaskSpareRuleLinkIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskSpareRuleLinkIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskSpareRuleLink->IsActive" } ] } } }, "BatchChangeRegularAssetTypeTaskSpareRuleLinkIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskSpareRuleLinkIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSpareRuleLinkIsActiveResourceActionRequest" } }, "GetRegularAssetTypeTaskSubTaskResourceActionResponse": { "title": "GetRegularAssetTypeTaskSubTaskResourceActionResponse", "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": "GetRegularAssetTypeTaskSubTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSubTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSubTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSubTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->SequenceNumber" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->AlternativeDescription" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskId": { "title": "inheritedFromRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->InheritedFrom_RegularAssetTypeTask_Id" }, "inheritedFromRegularAssetTypeTaskRecordType": { "title": "inheritedFromRegularAssetTypeTaskRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->InheritedFrom_RegularAssetTypeTask_RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" } } }, "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" } } }, "GetRegularAssetTypeTaskSubTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskSubTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskSubTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskSubTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->IsInherited" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->IsActive" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->AlternativeDescription" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTypeTaskSubTaskForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskSubTaskForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskSubTaskForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskSubTaskForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->IsInherited" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->SequenceNumber" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->AlternativeDescription" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSubTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSubTaskRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSubTaskRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSubTaskRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSubTaskRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->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" } } } }, "CreateRegularAssetTypeTaskSubTaskResourceActionRequest": { "title": "CreateRegularAssetTypeTaskSubTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskSubTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "description", "alternativeDescription" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->RegularAssetTypeTask_Id" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->AlternativeDescription" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskSubTaskResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskSubTaskResourceActionRequest", "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": "RegularAssetTypeTaskSubTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Notes" }, { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSubTask->Code" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->Description" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSubTask->AlternativeDescription" } ] } } }, "BatchGetRegularAssetTypeTaskSubTaskResourceAction": { "title": "BatchGetRegularAssetTypeTaskSubTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Sub Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Sub Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskSubTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskSubTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskSubTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskSubTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSubTaskResourceActionRequest" } }, "ChangeRegularAssetTypeTaskSubTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskSubTaskIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskSubTask->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskSubTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskSubTaskPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskSubTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskSubTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskSubTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSubTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskSubTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskSubTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSubTaskPermissionTreeResourceActionRequest" } }, "GetRegularAssetTypeTaskSuppressedTaskResourceActionResponse": { "title": "GetRegularAssetTypeTaskSuppressedTaskResourceActionResponse", "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": "GetRegularAssetTypeTaskSuppressedTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->IsActive" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SequenceNumber" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->Notes" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description" }, "suppressedTaskIsActive": { "title": "suppressedTaskIsActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_IsActive" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0" } } }, "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" } } }, "GetRegularAssetTypeTaskSuppressedTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTypeTaskSuppressedTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTypeTaskSuppressedTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTypeTaskSuppressedTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id" }, "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id" }, "regularAssetTypeTaskCode": { "title": "regularAssetTypeTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Code" }, "regularAssetTypeTaskDescription": { "title": "regularAssetTypeTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Description" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SequenceNumber" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetSuppressedTaskForRegularAssetTypeTaskCollectionResourceActionResponse": { "title": "GetSuppressedTaskForRegularAssetTypeTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSuppressedTaskForRegularAssetTypeTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSuppressedTaskForRegularAssetTypeTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SequenceNumber" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->ModifiedOn" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTypeTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTypeTaskSuppressedTaskRegularAssetTypeTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSuppressedTaskRegularAssetTypeTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSuppressedTaskRegularAssetTypeTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSuppressedTaskRegularAssetTypeTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->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" } } } }, "RegularAssetTypeTaskSuppressedTaskSuppressedTaskLookupResourceActionResponse": { "title": "RegularAssetTypeTaskSuppressedTaskSuppressedTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTypeTaskSuppressedTaskSuppressedTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTypeTaskSuppressedTaskSuppressedTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTask->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" } } } }, "CreateRegularAssetTypeTaskSuppressedTaskResourceActionRequest": { "title": "CreateRegularAssetTypeTaskSuppressedTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTypeTaskSuppressedTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTypeTaskId", "suppressedTaskId" ], "properties": { "regularAssetTypeTaskId": { "title": "regularAssetTypeTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->RegularAssetTypeTask_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SequenceNumber" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed", "x-systemGenerated": true }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage", "x-systemGenerated": true, "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter", "x-systemGenerated": true, "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore", "x-systemGenerated": true, "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTypeTaskSuppressedTaskResourceActionRequest": { "title": "UpdateRegularAssetTypeTaskSuppressedTaskResourceActionRequest", "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": "suppressedTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedTask_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SequenceNumber" }, { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter gt 0" }, { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTypeTaskSuppressedTask->SuppressionPercentage gt 0" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeTaskSuppressedTask->Notes" } ] } } }, "BatchGetRegularAssetTypeTaskSuppressedTaskResourceAction": { "title": "BatchGetRegularAssetTypeTaskSuppressedTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Type Task Suppressed Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Type Task Suppressed Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTypeTaskSuppressedTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTypeTaskSuppressedTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTypeTaskSuppressedTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTypeTaskSuppressedTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTypeTaskSuppressedTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTypeTaskSuppressedTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTypeTaskSuppressedTaskResourceActionRequest" } }, "ChangeRegularAssetTypeTaskSuppressedTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskSuppressedTaskIsActiveResourceActionRequest", "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": "RegularAssetTypeTaskSuppressedTask->IsActive" } ] } } }, "ChangeRegularAssetTypeTaskSuppressedTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTypeTaskSuppressedTaskPermissionTreeResourceActionRequest", "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": "RegularAssetTypeTaskSuppressedTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTypeTaskSuppressedTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskSuppressedTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSuppressedTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTypeTaskSuppressedTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTypeTaskSuppressedTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTypeTaskSuppressedTaskPermissionTreeResourceActionRequest" } }, "GetStandardTaskAttributeResourceActionResponse": { "title": "GetStandardTaskAttributeResourceActionResponse", "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": "GetStandardTaskAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->InheritedFrom_Id" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->StandardTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->IsBackup" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetStandardTaskAttributeCollectionForStandardTaskResourceActionResponse": { "title": "GetStandardTaskAttributeCollectionForStandardTaskResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskAttributeCollectionForStandardTaskResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskAttributeCollectionForStandardTaskResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->ModifiedOn" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->LastConfirmedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetStandardTaskAttributeCollectionResourceActionResponse": { "title": "GetStandardTaskAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->StandardTask_Description" }, "standardTaskAlternativeDescription": { "title": "standardTaskAlternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->StandardTask_AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskAttribute->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" } } } }, "StandardTaskAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "StandardTaskAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskAttributeAttributeLookupResourceActionResponse": { "title": "StandardTaskAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "StandardTaskAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "StandardTaskAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskAttributeStandardTaskLookupResourceActionResponse": { "title": "StandardTaskAttributeStandardTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAttributeStandardTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAttributeStandardTaskLookupResourceActionResponseItemProperties", "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" } } } }, "CreateStandardTaskAttributeResourceActionRequest": { "title": "CreateStandardTaskAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateStandardTaskAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "standardTaskId", "attributeId" ], "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->StandardTask_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "StandardTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateStandardTaskAttributeResourceActionRequest": { "title": "UpdateStandardTaskAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskAttribute->Notes" } ] } } }, "BatchGetStandardTaskAttributeResourceAction": { "title": "BatchGetStandardTaskAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Standard Task Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Standard Task Attribute entities", "items": { "$ref": "#/definitions/GetStandardTaskAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateStandardTaskAttributeResourceActionRequest": { "title": "BatchCreateStandardTaskAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateStandardTaskAttributeResourceActionRequest" } }, "BatchUpdateStandardTaskAttributeResourceActionRequest": { "title": "BatchUpdateStandardTaskAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateStandardTaskAttributeResourceActionRequest" } }, "ChangeStandardTaskAttributeIsActiveResourceActionRequest": { "title": "ChangeStandardTaskAttributeIsActiveResourceActionRequest", "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": "StandardTaskAttribute->IsActive" } ] } } }, "ChangeStandardTaskAttributePermissionTreeResourceActionRequest": { "title": "ChangeStandardTaskAttributePermissionTreeResourceActionRequest", "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": "StandardTaskAttribute->PermissionTree_Id" } ] } } }, "BatchChangeStandardTaskAttributeIsActiveResourceActionRequest": { "title": "BatchChangeStandardTaskAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskAttributeIsActiveResourceActionRequest" } }, "BatchChangeStandardTaskAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeStandardTaskAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskAttributePermissionTreeResourceActionRequest" } }, "GetStandardTaskDocumentResourceActionResponse": { "title": "GetStandardTaskDocumentResourceActionResponse", "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": "GetStandardTaskDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->InheritedFrom_Id" }, "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->StandardTask_Id" }, "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->StandardTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isBackup": { "title": "isBackup", "type": "boolean", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->IsBackup" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskDocument->LastConfirmedOn" }, "previousDevelopmentStatus": { "title": "previousDevelopmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->PreviousDevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->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" } } }, "GetStandardTaskDocumentCollectionForStandardTaskResourceActionResponse": { "title": "GetStandardTaskDocumentCollectionForStandardTaskResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskDocumentCollectionForStandardTaskResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskDocumentCollectionForStandardTaskResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->Notes" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskDocument->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" } } } }, "GetStandardTaskDocumentCollectionResourceActionResponse": { "title": "GetStandardTaskDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetStandardTaskDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetStandardTaskDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "standardTaskCode": { "title": "standardTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->StandardTask_Code" }, "standardTaskDescription": { "title": "standardTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->StandardTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetTypeDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->DocumentRecord_FileType_Extension" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "StandardTaskDocument->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" } } } }, "StandardTaskDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "StandardTaskDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskDocumentDocumentLookupResourceActionResponse": { "title": "StandardTaskDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "StandardTaskDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "StandardTaskDocumentStandardTaskLookupResourceActionResponse": { "title": "StandardTaskDocumentStandardTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskDocumentStandardTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskDocumentStandardTaskLookupResourceActionResponseItemProperties", "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" } } } }, "CreateStandardTaskDocumentResourceActionRequest": { "title": "CreateStandardTaskDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateStandardTaskDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "standardTaskId", "documentRecordId" ], "properties": { "standardTaskId": { "title": "standardTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->StandardTask_Id" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateStandardTaskDocumentResourceActionRequest": { "title": "UpdateStandardTaskDocumentResourceActionRequest", "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": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "StandardTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "StandardTaskDocument->Notes" } ] } } }, "DeleteStandardTaskDocumentResourceActionRequest": { "title": "DeleteStandardTaskDocumentResourceActionRequest", "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 } } }, "BatchGetStandardTaskDocumentResourceAction": { "title": "BatchGetStandardTaskDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Standard Task Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Standard Task Document entities", "items": { "$ref": "#/definitions/GetStandardTaskDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateStandardTaskDocumentResourceActionRequest": { "title": "BatchCreateStandardTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateStandardTaskDocumentResourceActionRequest" } }, "BatchUpdateStandardTaskDocumentResourceActionRequest": { "title": "BatchUpdateStandardTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateStandardTaskDocumentResourceActionRequest" } }, "BatchDeleteStandardTaskDocumentResourceActionRequest": { "title": "BatchDeleteStandardTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteStandardTaskDocumentResourceActionRequest" } }, "ChangeStandardTaskDocumentIsActiveResourceActionRequest": { "title": "ChangeStandardTaskDocumentIsActiveResourceActionRequest", "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": "StandardTaskDocument->IsActive" } ] } } }, "ChangeStandardTaskDocumentPermissionTreeResourceActionRequest": { "title": "ChangeStandardTaskDocumentPermissionTreeResourceActionRequest", "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": "StandardTaskDocument->PermissionTree_Id" } ] } } }, "BatchChangeStandardTaskDocumentIsActiveResourceActionRequest": { "title": "BatchChangeStandardTaskDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskDocumentIsActiveResourceActionRequest" } }, "BatchChangeStandardTaskDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeStandardTaskDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeStandardTaskDocumentPermissionTreeResourceActionRequest" } } }, "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 Type FMECA" }, { "name": "Asset Type FMECA Task" }, { "name": "Asset Type Folder" }, { "name": "Asset Type Function" }, { "name": "Asset Type Tree" }, { "name": "Auxiliary Asset Type Task" }, { "name": "Auxiliary Asset Type Task Resource" }, { "name": "Auxiliary Asset Type Task Spare" }, { "name": "Auxiliary Asset Type Task Sub Task" }, { "name": "In-Place Asset Type" }, { "name": "In-Place Asset Type Attribute" }, { "name": "In-Place Asset Type Responsibility" }, { "name": "In-Place Asset Type Rule Link" }, { "name": "In-Place Asset Type Spare" }, { "name": "Placeholder Asset Type" }, { "name": "Placeholder Asset Type Attribute" }, { "name": "Placeholder Asset Type Component" }, { "name": "Placeholder Asset Type Component Attribute" }, { "name": "Placeholder Asset Type Component Condition" }, { "name": "Placeholder Asset Type Component Document" }, { "name": "Placeholder Asset Type Component Rule Link" }, { "name": "Placeholder Asset Type Condition" }, { "name": "Placeholder Asset Type Document" }, { "name": "Placeholder Asset Type Responsibility" }, { "name": "Placeholder Asset Type Rule Link" }, { "name": "Placeholder Asset Type Spare" }, { "name": "Regular Asset Type" }, { "name": "Regular Asset Type Attribute" }, { "name": "Regular Asset Type Component" }, { "name": "Regular Asset Type Component Attribute" }, { "name": "Regular Asset Type Component Document" }, { "name": "Regular Asset Type Component Rule Link" }, { "name": "Regular Asset Type Condition" }, { "name": "Regular Asset Type Document" }, { "name": "Regular Asset Type File Attachment" }, { "name": "Regular Asset Type Monitoring Point Trigger" }, { "name": "Regular Asset Type Option" }, { "name": "Regular Asset Type Responsibility" }, { "name": "Regular Asset Type Rule" }, { "name": "Regular Asset Type Spare" }, { "name": "Regular Asset Type Task" }, { "name": "Regular Asset Type Task Attribute" }, { "name": "Regular Asset Type Task Auxiliary Task" }, { "name": "Regular Asset Type Task Condition" }, { "name": "Regular Asset Type Task Document" }, { "name": "Regular Asset Type Task Follow Up Task" }, { "name": "Regular Asset Type Task Follow Up Task Expression" }, { "name": "Regular Asset Type Task Resource" }, { "name": "Regular Asset Type Task Resource Rule Link" }, { "name": "Regular Asset Type Task Rule Link" }, { "name": "Regular Asset Type Task Spare" }, { "name": "Regular Asset Type Task Spare Rule Link" }, { "name": "Regular Asset Type Task Sub Task" }, { "name": "Regular Asset Type Task Suppressed Task" }, { "name": "Standard Task Attribute" }, { "name": "Standard Task Document" } ], "x-tagGroups": [ { "name": "AMPC.AssetTypes", "tags": [ "Asset Type FMECA", "Asset Type FMECA Task", "Asset Type Folder", "Asset Type Function", "Asset Type Tree", "Auxiliary Asset Type Task", "Auxiliary Asset Type Task Resource", "Auxiliary Asset Type Task Spare", "Auxiliary Asset Type Task Sub Task", "In-Place Asset Type", "In-Place Asset Type Attribute", "In-Place Asset Type Responsibility", "In-Place Asset Type Rule Link", "In-Place Asset Type Spare", "Placeholder Asset Type", "Placeholder Asset Type Attribute", "Placeholder Asset Type Component", "Placeholder Asset Type Component Attribute", "Placeholder Asset Type Component Condition", "Placeholder Asset Type Component Document", "Placeholder Asset Type Component Rule Link", "Placeholder Asset Type Condition", "Placeholder Asset Type Document", "Placeholder Asset Type Responsibility", "Placeholder Asset Type Rule Link", "Placeholder Asset Type Spare", "Regular Asset Type", "Regular Asset Type Attribute", "Regular Asset Type Component", "Regular Asset Type Component Attribute", "Regular Asset Type Component Document", "Regular Asset Type Component Rule Link", "Regular Asset Type Condition", "Regular Asset Type Document", "Regular Asset Type File Attachment", "Regular Asset Type Monitoring Point Trigger", "Regular Asset Type Option", "Regular Asset Type Responsibility", "Regular Asset Type Rule", "Regular Asset Type Spare", "Regular Asset Type Task", "Regular Asset Type Task Attribute", "Regular Asset Type Task Auxiliary Task", "Regular Asset Type Task Condition", "Regular Asset Type Task Document", "Regular Asset Type Task Follow Up Task", "Regular Asset Type Task Follow Up Task Expression", "Regular Asset Type Task Resource", "Regular Asset Type Task Resource Rule Link", "Regular Asset Type Task Rule Link", "Regular Asset Type Task Spare", "Regular Asset Type Task Spare Rule Link", "Regular Asset Type Task Sub Task", "Regular Asset Type Task Suppressed Task", "Standard Task Attribute", "Standard Task Document" ] } ] }