{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key AMPC Assets API Specification", "description": "Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.", "termsOfService": "https://www.onkey.com/", "contact": { "name": "On Key Support", "url": "https://www.onkey.com/", "email": "onkey.support@pragmaworld.net" }, "license": { "name": "On Key Licence", "url": "https://www.onkey.com/" }, "version": "1.0.0" }, "host": ":443", "basePath": "/api/tenants/{client}/{connection}", "schemes": [ "https" ], "consumes": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitydelete+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitydeletecollection+json", "application/vnd.onkey.entitymatchupdatecollection+json", "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/AssetFmecas/{id}": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a Asset 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 | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AssetFmeca->Id | integer | int64 |\r\n| isActive | AssetFmeca->IsActive | boolean | |\r\n| isHistorical | AssetFmeca->IsHistorical | boolean | |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| isProposed | AssetFmeca->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AssetFmeca->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AssetFmeca->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AssetFmeca->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AssetFmeca->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AssetFmeca->Unsynchronised | boolean | |\r\n| createdByUserId | AssetFmeca->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetFmeca->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetFmeca->CreatedByUser_FullName | string | |\r\n| createdOn | AssetFmeca->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetFmeca->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetFmeca->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetFmeca->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetFmeca->ModifiedOn | string | date-time |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetFmeca->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetFmeca->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetFmeca->PermissionTree_Description | string | |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetDescription | AssetFmeca->Asset_Description | string | |\r\n| assetRecordType | AssetFmeca->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetNearestRegularAssetId | AssetFmeca->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetCode | AssetFmeca->Asset_NearestRegularAsset_Code | string | |\r\n| assetNearestRegularAssetDescription | AssetFmeca->Asset_NearestRegularAsset_Description | string | |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| assetFunctionDescription | AssetFmeca->AssetFunction_Description | string | |\r\n| componentId | AssetFmeca->Component_Id | integer | int64 |\r\n| componentCode | AssetFmeca->Component_Code | string | |\r\n| componentDescription | AssetFmeca->Component_Description | string | |\r\n| componentRecordType | AssetFmeca->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetId | AssetFmeca->Component_Asset_Id | integer | int64 |\r\n| componentAssetCode | AssetFmeca->Component_Asset_Code | string | |\r\n| componentAssetDescription | AssetFmeca->Component_Asset_Description | string | |\r\n| componentAssetRecordType | AssetFmeca->Component_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetNearestRegularAssetId | AssetFmeca->Component_Asset_NearestRegularAsset_Id | integer | int64 |\r\n| componentAssetNearestRegularAssetCode | AssetFmeca->Component_Asset_NearestRegularAsset_Code | string | |\r\n| componentAssetNearestRegularAssetDescription | AssetFmeca->Component_Asset_NearestRegularAsset_Description | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| failureCauseDescription | AssetFmeca->FailureCause_Description | string | |\r\n| failureCauseAdditionalInformation | AssetFmeca->FailureCauseAdditionalInformation | string | |\r\n| failureCauseTypeId | AssetFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | AssetFmeca->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | AssetFmeca->FailureCauseType_Description | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureMechanismDescription | AssetFmeca->FailureMechanism_Description | string | |\r\n| failureMechanismAdditionalInformation | AssetFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | AssetFmeca->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | AssetFmeca->FailureMechanismType_Description | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureModeDescription | AssetFmeca->FailureMode_Description | string | |\r\n| failureModeAdditionalInformation | AssetFmeca->FailureModeAdditionalInformation | string | |\r\n| failureModeTypeId | AssetFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | AssetFmeca->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | AssetFmeca->FailureModeType_Description | string | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AssetFmeca->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| isFailureEvident | AssetFmeca->IsFailureEvident | boolean | |\r\n| isLegacy | AssetFmeca->IsLegacy | boolean | |\r\n| linkedToEntityType | AssetFmeca->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 | AssetFmeca->Notes | string | |\r\n| repairTypeId | AssetFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeCode | AssetFmeca->RepairType_Code | string | |\r\n| repairTypeDescription | AssetFmeca->RepairType_Description | string | |\r\n| repairTypeAdditionalInformation | AssetFmeca->RepairTypeAdditionalInformation | string | |\r\n| warningEffects | AssetFmeca->WarningEffects | string | |\r\n", "operationId": "GetAssetFmeca", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset FMECA", "schema": { "$ref": "#/definitions/GetAssetFmecaResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset FMECA" ], "summary": "Update an existing Asset 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 | AssetFmeca->Version | integer | int32 |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| sequenceNumber | AssetFmeca->SequenceNumber | integer | int32 |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | AssetFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | AssetFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | AssetFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetFmeca->FailureCauseAdditionalInformation | string | |\r\n| isFailureEvident | AssetFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetFmeca->WarningEffects | string | |\r\n| repairTypeId | AssetFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetFmeca->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | AssetFmeca->FailureCauseType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "UpdateAssetFmeca", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetFmecaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset 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" } } }, "delete": { "tags": [ "Asset FMECA" ], "summary": "Delete an existing Asset 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 | AssetFmeca->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": "DeleteAssetFmeca", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDeleteAssetFmecaResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset FMECA 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/AssetFmecas": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a collection of Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetTreePathItems | AssetFmeca->Asset_TreePathItems | array | array |\r\n| componentId | AssetFmeca->Component_Id | integer | int64 |\r\n| componentCode | AssetFmeca->Component_Code | string | |\r\n| componentTreePathItems | AssetFmeca->Component_TreePathItems | array | array |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| linkedToEntityType | AssetFmeca->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| developmentStatus | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA collection", "schema": { "$ref": "#/definitions/GetAssetFmecaCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset FMECA" ], "summary": "Create a new Asset 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| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| componentId | AssetFmeca->Component_Id | integer | int64 |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| permissionTreeId | AssetFmeca->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetFmeca->SequenceNumber | integer | int32 |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | AssetFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | AssetFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | AssetFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetFmeca->FailureCauseAdditionalInformation | string | |\r\n| isFailureEvident | AssetFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetFmeca->WarningEffects | string | |\r\n| repairTypeId | AssetFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetFmeca->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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 | AssetFmeca->FailureCauseType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "CreateAssetFmeca", "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/CreateAssetFmecaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Fmecas": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a collection of Asset FMECA resources for the InPlace Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaForInPlaceAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA collection", "schema": { "$ref": "#/definitions/GetAssetFmecaForInPlaceAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/{id}/Fmecas": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a collection of Asset FMECA resources for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaForPlaceholderAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA collection", "schema": { "$ref": "#/definitions/GetAssetFmecaForPlaceholderAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/Fmecas": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a collection of Asset FMECA resources for the Placeholder Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaForPlaceholderAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA collection", "schema": { "$ref": "#/definitions/GetAssetFmecaForPlaceholderAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{id}/Fmecas": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a collection of Asset FMECA resources for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaForRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA collection", "schema": { "$ref": "#/definitions/GetAssetFmecaForRegularAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/{id}/Fmecas": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a collection of Asset FMECA resources for the Regular Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| developmentStatus | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaForRegularAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA collection", "schema": { "$ref": "#/definitions/GetAssetFmecaForRegularAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaAssetFunctionFromAssetComponent": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Asset Function for the Asset FMECA, filtered by Asset 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 | AssetFunction->Id | integer | int64 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n", "operationId": "LookupAssetFmecaAssetFunctionFromAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Function collection", "schema": { "$ref": "#/definitions/AssetFmecaAssetFunctionFromAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaAssetFunctionFromAsset": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Asset Function for the Asset FMECA, filtered by Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetFunction->Id | integer | int64 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n", "operationId": "LookupAssetFmecaAssetFunctionFromAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Function collection", "schema": { "$ref": "#/definitions/AssetFmecaAssetFunctionFromAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaAsset": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Asset for the Asset 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 | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetFmecaAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/AssetFmecaAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaChangePermissionTree": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the permission set for changing the Asset 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": "LookupAssetFmecaChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaComponent": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Asset Component for the Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| recordType | AssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetFmecaComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/AssetFmecaComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureCauseFromFailureCauseType": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Cause for the Asset 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": "LookupAssetFmecaFailureCauseFromFailureCauseType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureCause": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Cause for the Asset 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": "LookupAssetFmecaFailureCause", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureCauseLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureCauseType": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Cause Type for the Asset 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": "LookupAssetFmecaFailureCauseType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureCauseTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureMechanismFromFailureMechanismType": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Mechanism for the Asset 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": "LookupAssetFmecaFailureMechanismFromFailureMechanismType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureMechanismFromAssetFmecaFailureMechanismTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureMechanism": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Mechanism for the Asset 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": "LookupAssetFmecaFailureMechanism", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureMechanismLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureMechanismType": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Mechanism Type for the Asset 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": "LookupAssetFmecaFailureMechanismType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureMechanismTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureModeFromFailureModeType": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Mode for the Asset 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": "LookupAssetFmecaFailureModeFromFailureModeType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureModeFromFailureModeTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureMode": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Mode for the Asset 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": "LookupAssetFmecaFailureMode", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureModeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaFailureModeType": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Failure Mode Type for the Asset 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": "LookupAssetFmecaFailureModeType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaFailureModeTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaInsertPermissionTree": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the permission set for creating the Asset 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": "LookupAssetFmecaInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Lookups/LookupAssetFmecaRepairType": { "get": { "tags": [ "Asset FMECA" ], "summary": "Lookup the Repair Type for the Asset 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": "LookupAssetFmecaRepairType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaRepairTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Batch/{ids}": { "get": { "tags": [ "Asset FMECA" ], "summary": "Get a collection of Asset 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 | AssetFmeca->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AssetFmeca->Id | integer | int64 |\r\n| isActive | AssetFmeca->IsActive | boolean | |\r\n| isHistorical | AssetFmeca->IsHistorical | boolean | |\r\n| isInherited | AssetFmeca->IsInherited | boolean | |\r\n| isProposed | AssetFmeca->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AssetFmeca->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AssetFmeca->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AssetFmeca->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AssetFmeca->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AssetFmeca->Unsynchronised | boolean | |\r\n| createdByUserId | AssetFmeca->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetFmeca->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetFmeca->CreatedByUser_FullName | string | |\r\n| createdOn | AssetFmeca->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetFmeca->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetFmeca->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetFmeca->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetFmeca->ModifiedOn | string | date-time |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetFmeca->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetFmeca->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetFmeca->PermissionTree_Description | string | |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetDescription | AssetFmeca->Asset_Description | string | |\r\n| assetRecordType | AssetFmeca->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetNearestRegularAssetId | AssetFmeca->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetCode | AssetFmeca->Asset_NearestRegularAsset_Code | string | |\r\n| assetNearestRegularAssetDescription | AssetFmeca->Asset_NearestRegularAsset_Description | string | |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| assetFunctionCode | AssetFmeca->AssetFunction_Code | string | |\r\n| assetFunctionDescription | AssetFmeca->AssetFunction_Description | string | |\r\n| componentId | AssetFmeca->Component_Id | integer | int64 |\r\n| componentCode | AssetFmeca->Component_Code | string | |\r\n| componentDescription | AssetFmeca->Component_Description | string | |\r\n| componentRecordType | AssetFmeca->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetId | AssetFmeca->Component_Asset_Id | integer | int64 |\r\n| componentAssetCode | AssetFmeca->Component_Asset_Code | string | |\r\n| componentAssetDescription | AssetFmeca->Component_Asset_Description | string | |\r\n| componentAssetRecordType | AssetFmeca->Component_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetNearestRegularAssetId | AssetFmeca->Component_Asset_NearestRegularAsset_Id | integer | int64 |\r\n| componentAssetNearestRegularAssetCode | AssetFmeca->Component_Asset_NearestRegularAsset_Code | string | |\r\n| componentAssetNearestRegularAssetDescription | AssetFmeca->Component_Asset_NearestRegularAsset_Description | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseCode | AssetFmeca->FailureCause_Code | string | |\r\n| failureCauseDescription | AssetFmeca->FailureCause_Description | string | |\r\n| failureCauseAdditionalInformation | AssetFmeca->FailureCauseAdditionalInformation | string | |\r\n| failureCauseTypeId | AssetFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseTypeCode | AssetFmeca->FailureCauseType_Code | string | |\r\n| failureCauseTypeDescription | AssetFmeca->FailureCauseType_Description | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismCode | AssetFmeca->FailureMechanism_Code | string | |\r\n| failureMechanismDescription | AssetFmeca->FailureMechanism_Description | string | |\r\n| failureMechanismAdditionalInformation | AssetFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureMechanismTypeId | AssetFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismTypeCode | AssetFmeca->FailureMechanismType_Code | string | |\r\n| failureMechanismTypeDescription | AssetFmeca->FailureMechanismType_Description | string | |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeCode | AssetFmeca->FailureMode_Code | string | |\r\n| failureModeDescription | AssetFmeca->FailureMode_Description | string | |\r\n| failureModeAdditionalInformation | AssetFmeca->FailureModeAdditionalInformation | string | |\r\n| failureModeTypeId | AssetFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeTypeCode | AssetFmeca->FailureModeType_Code | string | |\r\n| failureModeTypeDescription | AssetFmeca->FailureModeType_Description | string | |\r\n| inheritedFromId | AssetFmeca->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AssetFmeca->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| isFailureEvident | AssetFmeca->IsFailureEvident | boolean | |\r\n| isLegacy | AssetFmeca->IsLegacy | boolean | |\r\n| linkedToEntityType | AssetFmeca->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 | AssetFmeca->Notes | string | |\r\n| repairTypeId | AssetFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeCode | AssetFmeca->RepairType_Code | string | |\r\n| repairTypeDescription | AssetFmeca->RepairType_Description | string | |\r\n| repairTypeAdditionalInformation | AssetFmeca->RepairTypeAdditionalInformation | string | |\r\n| warningEffects | AssetFmeca->WarningEffects | string | |\r\n", "operationId": "BatchGetAssetFmeca", "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 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 FMECA collection", "schema": { "$ref": "#/definitions/BatchGetAssetFmecaResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Batch": { "post": { "tags": [ "Asset FMECA" ], "summary": "Create a new collection of Asset 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| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| componentId | AssetFmeca->Component_Id | integer | int64 |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| permissionTreeId | AssetFmeca->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetFmeca->SequenceNumber | integer | int32 |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | AssetFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | AssetFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | AssetFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetFmeca->FailureCauseAdditionalInformation | string | |\r\n| isFailureEvident | AssetFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetFmeca->WarningEffects | string | |\r\n| repairTypeId | AssetFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetFmeca->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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 | AssetFmeca->FailureCauseType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchCreateAssetFmeca", "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/BatchCreateAssetFmecaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Asset 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 FMECA" ], "summary": "Update a collection of existing Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| assetFunctionId | AssetFmeca->AssetFunction_Id | integer | int64 |\r\n| sequenceNumber | AssetFmeca->SequenceNumber | integer | int32 |\r\n| failureModeId | AssetFmeca->FailureMode_Id | integer | int64 |\r\n| failureModeTypeId | AssetFmeca->FailureModeType_Id | integer | int64 |\r\n| failureModeAdditionalInformation | AssetFmeca->FailureModeAdditionalInformation | string | |\r\n| failureMechanismId | AssetFmeca->FailureMechanism_Id | integer | int64 |\r\n| failureMechanismTypeId | AssetFmeca->FailureMechanismType_Id | integer | int64 |\r\n| failureMechanismAdditionalInformation | AssetFmeca->FailureMechanismAdditionalInformation | string | |\r\n| failureCauseId | AssetFmeca->FailureCause_Id | integer | int64 |\r\n| failureCauseTypeId | AssetFmeca->FailureCauseType_Id | integer | int64 |\r\n| failureCauseAdditionalInformation | AssetFmeca->FailureCauseAdditionalInformation | string | |\r\n| isFailureEvident | AssetFmeca->IsFailureEvident | boolean | |\r\n| warningEffects | AssetFmeca->WarningEffects | string | |\r\n| repairTypeId | AssetFmeca->RepairType_Id | integer | int64 |\r\n| repairTypeAdditionalInformation | AssetFmeca->RepairTypeAdditionalInformation | string | |\r\n| notes | AssetFmeca->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| failureModeTypeId | Nullable | False | AssetFmeca->FailureCauseType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureModeAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureModeAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureMechanismTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureCauseType_Id eq NULL |\r\n| failureMechanismAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureMechanismAdditionalInformation | Max Length | <= 255 chars| |\r\n| failureCauseTypeId | Nullable | False | AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL |\r\n| failureCauseAdditionalInformation | Min Length | >= 1 chars| |\r\n| failureCauseAdditionalInformation | Max Length | <= 255 chars| |\r\n| warningEffects | Min Length | >= 1 chars| |\r\n| warningEffects | Max Length | <= 255 chars| |\r\n| repairTypeAdditionalInformation | Min Length | >= 1 chars| |\r\n| repairTypeAdditionalInformation | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchUpdateAssetFmeca", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAssetFmecaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset 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" } } }, "delete": { "tags": [ "Asset FMECA" ], "summary": "Delete a collection of existing Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteAssetFmeca", "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/BatchDeleteAssetFmecaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset FMECA 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/AssetFmecas/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset FMECA" ], "summary": "Accept the Development Status for an existing Asset FMECA resource.", "description": "", "operationId": "AcceptAssetFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset FMECA" ], "summary": "Accept the Development Status for the collection of existing Asset FMECA resource id's.", "description": "", "operationId": "BatchAcceptAssetFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset FMECA id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset FMECA" ], "summary": "Reject the Development Status for the collection of existing Asset FMECA resource id's.", "description": "", "operationId": "BatchRejectAssetFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset FMECA id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/{id}/Active": { "patch": { "tags": [ "Asset FMECA" ], "summary": "Change the IsActive status for an existing Asset 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 | AssetFmeca->Version | integer | int32 |\r\n| isActive | AssetFmeca->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": "ChangeAssetFmecaIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetFmecaIsActiveResourceActionRequest" } }, { "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/AssetFmecas/{id}/PermissionTree": { "patch": { "tags": [ "Asset FMECA" ], "summary": "Change the PermissionTree for an existing Asset 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 | AssetFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetFmeca->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": "ChangeAssetFmecaPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetFmecaPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset FMECA" ], "summary": "Reject the Development Status for an existing Asset FMECA resource.", "description": "", "operationId": "RejectAssetFmecaDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Batch/Active": { "patch": { "tags": [ "Asset FMECA" ], "summary": "Change the IsActive status for a collection of existing Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| isActive | AssetFmeca->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": "BatchChangeAssetFmecaIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetFmecaIsActiveResourceActionRequest" } }, { "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/AssetFmecas/Batch/PermissionTree": { "patch": { "tags": [ "Asset FMECA" ], "summary": "Change the PermissionTree status for a collection of existing Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| version | AssetFmeca->Version | integer | int32 |\r\n| permissionTreeId | AssetFmeca->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": "BatchChangeAssetFmecaPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetFmecaPermissionTreeResourceActionRequest" } }, { "$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/AssetFmecas/Tasks/{id}": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Get a Asset 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 | AssetFmecaTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AssetFmecaTask->Id | integer | int64 |\r\n| isActive | AssetFmecaTask->IsActive | boolean | |\r\n| isHistorical | AssetFmecaTask->IsHistorical | boolean | |\r\n| isInherited | AssetFmecaTask->IsInherited | boolean | |\r\n| isProposed | AssetFmecaTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AssetFmecaTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AssetFmecaTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AssetFmecaTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AssetFmecaTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AssetFmecaTask->Unsynchronised | boolean | |\r\n| createdByUserId | AssetFmecaTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetFmecaTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetFmecaTask->CreatedByUser_FullName | string | |\r\n| createdOn | AssetFmecaTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetFmecaTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetFmecaTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetFmecaTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetFmecaTask->ModifiedOn | string | date-time |\r\n| version | AssetFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetFmecaTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetFmecaTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetFmecaTask->PermissionTree_Description | string | |\r\n| assetFmecaId | AssetFmecaTask->AssetFmeca_Id | integer | int64 |\r\n| assetFmecaAssetId | AssetFmecaTask->AssetFmeca_Asset_Id | integer | int64 |\r\n| assetFmecaAssetCode | AssetFmecaTask->AssetFmeca_Asset_Code | string | |\r\n| assetFmecaAssetDescription | AssetFmecaTask->AssetFmeca_Asset_Description | string | |\r\n| inheritedFromId | AssetFmecaTask->InheritedFrom_Id | integer | int64 |\r\n| notes | AssetFmecaTask->Notes | string | |\r\n| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | AssetFmecaTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AssetFmecaTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetId | AssetFmecaTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetCode | AssetFmecaTask->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskAssetDescription | AssetFmecaTask->RegularAssetTask_Asset_Description | string | |\r\n| regularAssetTaskComponentId | AssetFmecaTask->RegularAssetTask_Component_Id | integer | int64 |\r\n| regularAssetTaskComponentCode | AssetFmecaTask->RegularAssetTask_Component_Code | string | |\r\n| regularAssetTaskComponentDescription | AssetFmecaTask->RegularAssetTask_Component_Description | string | |\r\n", "operationId": "GetAssetFmecaTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset FMECA Task", "schema": { "$ref": "#/definitions/GetAssetFmecaTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset FMECA Task" ], "summary": "Update an existing Asset 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 | AssetFmecaTask->Version | integer | int32 |\r\n| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| sequenceNumber | AssetFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetFmecaTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| regularAssetTaskId | Nullable | False | |\r\n\r\n", "operationId": "UpdateAssetFmecaTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetFmecaTaskResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset 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" } } }, "delete": { "tags": [ "Asset FMECA Task" ], "summary": "Delete an existing Asset 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 | AssetFmecaTask->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": "DeleteAssetFmecaTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDeleteAssetFmecaTaskResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset FMECA Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Get a collection of Asset 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 | AssetFmecaTask->Id | integer | int64 |\r\n| version | AssetFmecaTask->Version | integer | int32 |\r\n| assetFmecaAssetCode | AssetFmecaTask->AssetFmeca_Asset_Code | string | |\r\n| assetFmecaComponentCode | AssetFmecaTask->AssetFmeca_Component_Code | string | |\r\n| assetFmecaLinkedToEntityType | AssetFmecaTask->AssetFmeca_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| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | AssetFmecaTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AssetFmecaTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetId | AssetFmecaTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetCode | AssetFmecaTask->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskAssetDescription | AssetFmecaTask->RegularAssetTask_Asset_Description | string | |\r\n| regularAssetTaskAssetTreePathItems | AssetFmecaTask->RegularAssetTask_Asset_TreePathItems | array | array |\r\n| regularAssetTaskComponentCode | AssetFmecaTask->RegularAssetTask_Component_Code | string | |\r\n| regularAssetTaskComponentDescription | AssetFmecaTask->RegularAssetTask_Component_Description | string | |\r\n| regularAssetTaskComponentTreePathItems | AssetFmecaTask->RegularAssetTask_Component_TreePathItems | array | array |\r\n| developmentStatus | AssetFmecaTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmecaTask->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmecaTask->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA Task collection", "schema": { "$ref": "#/definitions/GetAssetFmecaTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset FMECA Task" ], "summary": "Create a new Asset 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| assetFmecaId | AssetFmecaTask->AssetFmeca_Id | integer | int64 |\r\n| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| permissionTreeId | AssetFmecaTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetFmecaTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetFmecaId | Required | True | |\r\n| assetFmecaId | Nullable | False | |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAssetFmecaTask", "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/CreateAssetFmecaTaskResourceActionResponse" } }, { "$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/AssetFmecas/{assetFmecaId}/Tasks": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Get a collection of Asset FMECA Task resources for the Asset 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 | AssetFmecaTask->Id | integer | int64 |\r\n| version | AssetFmecaTask->Version | integer | int32 |\r\n| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | AssetFmecaTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AssetFmecaTask->RegularAssetTask_Description | string | |\r\n| developmentStatus | AssetFmecaTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFmecaTask->IsInherited | boolean | |\r\n| inheritedFromId | AssetFmecaTask->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFmecaTaskForAssetFmecaCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "assetFmecaId", "in": "path", "required": true, "description": "Asset 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 FMECA Task collection", "schema": { "$ref": "#/definitions/GetAssetFmecaTaskForAssetFmecaCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Lookups/LookupAssetFmecaTaskAssetFmeca": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Lookup the Asset FMECA for the Asset 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 | AssetFmeca->Id | integer | int64 |\r\n| assetId | AssetFmeca->Asset_Id | integer | int64 |\r\n| assetCode | AssetFmeca->Asset_Code | string | |\r\n| assetDescription | AssetFmeca->Asset_Description | string | |\r\n| componentId | AssetFmeca->Component_Id | integer | int64 |\r\n| componentCode | AssetFmeca->Component_Code | string | |\r\n| componentDescription | AssetFmeca->Component_Description | string | |\r\n", "operationId": "LookupAssetFmecaTaskAssetFmeca", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset FMECA collection", "schema": { "$ref": "#/definitions/AssetFmecaTaskAssetFmecaLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Lookups/LookupAssetFmecaTaskRegularAssetTaskFromAssetComponent": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Lookup the Regular Asset Task for the Asset FMECA Task, filtered by Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetRecordType | RegularAssetTask->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTreePathItems | RegularAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTask->Component_TreePathItems | array | array |\r\n", "operationId": "LookupAssetFmecaTaskRegularAssetTaskFromAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/AssetFmecaTaskAssetTaskFromAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Lookups/LookupAssetFmecaTaskRegularAssetTaskFromAsset": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Lookup the Regular Asset Task for the Asset FMECA Task, filtered by Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetRecordType | RegularAssetTask->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTreePathItems | RegularAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTask->Component_TreePathItems | array | array |\r\n", "operationId": "LookupAssetFmecaTaskRegularAssetTaskFromAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/AssetFmecaTaskAssetTaskFromAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Lookups/LookupAssetFmecaTaskChangePermissionTree": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Lookup the permission set for changing the Asset 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": "LookupAssetFmecaTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Lookups/LookupAssetFmecaTaskInsertPermissionTree": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Lookup the permission set for creating the Asset 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": "LookupAssetFmecaTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFmecaTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Batch/{ids}": { "get": { "tags": [ "Asset FMECA Task" ], "summary": "Get a collection of Asset 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 | AssetFmecaTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AssetFmecaTask->Id | integer | int64 |\r\n| isActive | AssetFmecaTask->IsActive | boolean | |\r\n| isHistorical | AssetFmecaTask->IsHistorical | boolean | |\r\n| isInherited | AssetFmecaTask->IsInherited | boolean | |\r\n| isProposed | AssetFmecaTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AssetFmecaTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AssetFmecaTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AssetFmecaTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AssetFmecaTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AssetFmecaTask->Unsynchronised | boolean | |\r\n| createdByUserId | AssetFmecaTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetFmecaTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetFmecaTask->CreatedByUser_FullName | string | |\r\n| createdOn | AssetFmecaTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetFmecaTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetFmecaTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetFmecaTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetFmecaTask->ModifiedOn | string | date-time |\r\n| version | AssetFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetFmecaTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetFmecaTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetFmecaTask->PermissionTree_Description | string | |\r\n| assetFmecaId | AssetFmecaTask->AssetFmeca_Id | integer | int64 |\r\n| assetFmecaAssetId | AssetFmecaTask->AssetFmeca_Asset_Id | integer | int64 |\r\n| assetFmecaAssetCode | AssetFmecaTask->AssetFmeca_Asset_Code | string | |\r\n| assetFmecaAssetDescription | AssetFmecaTask->AssetFmeca_Asset_Description | string | |\r\n| inheritedFromId | AssetFmecaTask->InheritedFrom_Id | integer | int64 |\r\n| notes | AssetFmecaTask->Notes | string | |\r\n| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | AssetFmecaTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AssetFmecaTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetId | AssetFmecaTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetCode | AssetFmecaTask->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskAssetDescription | AssetFmecaTask->RegularAssetTask_Asset_Description | string | |\r\n| regularAssetTaskComponentId | AssetFmecaTask->RegularAssetTask_Component_Id | integer | int64 |\r\n| regularAssetTaskComponentCode | AssetFmecaTask->RegularAssetTask_Component_Code | string | |\r\n| regularAssetTaskComponentDescription | AssetFmecaTask->RegularAssetTask_Component_Description | string | |\r\n", "operationId": "BatchGetAssetFmecaTask", "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 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 FMECA Task collection", "schema": { "$ref": "#/definitions/BatchGetAssetFmecaTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Batch": { "post": { "tags": [ "Asset FMECA Task" ], "summary": "Create a new collection of Asset 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| assetFmecaId | AssetFmecaTask->AssetFmeca_Id | integer | int64 |\r\n| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| permissionTreeId | AssetFmecaTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetFmecaTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetFmecaId | Required | True | |\r\n| assetFmecaId | Nullable | False | |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAssetFmecaTask", "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/BatchCreateAssetFmecaTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Asset 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 FMECA Task" ], "summary": "Update a collection of existing Asset 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 | AssetFmecaTask->Id | integer | int64 |\r\n| version | AssetFmecaTask->Version | integer | int32 |\r\n| regularAssetTaskId | AssetFmecaTask->RegularAssetTask_Id | integer | int64 |\r\n| sequenceNumber | AssetFmecaTask->SequenceNumber | integer | int32 |\r\n| notes | AssetFmecaTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| regularAssetTaskId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateAssetFmecaTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAssetFmecaTaskResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset 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" } } }, "delete": { "tags": [ "Asset FMECA Task" ], "summary": "Delete a collection of existing Asset 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 | AssetFmecaTask->Id | integer | int64 |\r\n| version | AssetFmecaTask->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": "BatchDeleteAssetFmecaTask", "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/BatchDeleteAssetFmecaTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset FMECA Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset FMECA Task" ], "summary": "Accept the Development Status for an existing Asset FMECA Task resource.", "description": "", "operationId": "AcceptAssetFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset FMECA Task" ], "summary": "Accept the Development Status for the collection of existing Asset FMECA Task resource id's.", "description": "", "operationId": "BatchAcceptAssetFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset FMECA Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset FMECA Task" ], "summary": "Reject the Development Status for the collection of existing Asset FMECA Task resource id's.", "description": "", "operationId": "BatchRejectAssetFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset FMECA Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/{id}/Active": { "patch": { "tags": [ "Asset FMECA Task" ], "summary": "Change the IsActive status for an existing Asset 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 | AssetFmecaTask->Version | integer | int32 |\r\n| isActive | AssetFmecaTask->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": "ChangeAssetFmecaTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetFmecaTaskIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/{id}/PermissionTree": { "patch": { "tags": [ "Asset FMECA Task" ], "summary": "Change the PermissionTree for an existing Asset 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 | AssetFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetFmecaTask->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": "ChangeAssetFmecaTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetFmecaTaskPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset FMECA Task" ], "summary": "Reject the Development Status for an existing Asset FMECA Task resource.", "description": "", "operationId": "RejectAssetFmecaTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset FMECA Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFmecas/Tasks/Batch/Active": { "patch": { "tags": [ "Asset FMECA Task" ], "summary": "Change the IsActive status for a collection of existing Asset 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 | AssetFmecaTask->Id | integer | int64 |\r\n| version | AssetFmecaTask->Version | integer | int32 |\r\n| isActive | AssetFmecaTask->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": "BatchChangeAssetFmecaTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetFmecaTaskIsActiveResourceActionRequest" } }, { "$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/AssetFmecas/Tasks/Batch/PermissionTree": { "patch": { "tags": [ "Asset FMECA Task" ], "summary": "Change the PermissionTree status for a collection of existing Asset 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 | AssetFmecaTask->Id | integer | int64 |\r\n| version | AssetFmecaTask->Version | integer | int32 |\r\n| permissionTreeId | AssetFmecaTask->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": "BatchChangeAssetFmecaTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetFmecaTaskPermissionTreeResourceActionRequest" } }, { "$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/AssetFunctions/{id}": { "get": { "tags": [ "Asset Function" ], "summary": "Get a Asset 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 | AssetFunction->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AssetFunction->Id | integer | int64 |\r\n| isActive | AssetFunction->IsActive | boolean | |\r\n| isHistorical | AssetFunction->IsHistorical | boolean | |\r\n| isInherited | AssetFunction->IsInherited | boolean | |\r\n| isProposed | AssetFunction->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AssetFunction->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AssetFunction->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AssetFunction->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AssetFunction->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AssetFunction->Unsynchronised | boolean | |\r\n| code | AssetFunction->Code | string | |\r\n| createdByUserId | AssetFunction->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetFunction->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetFunction->CreatedByUser_FullName | string | |\r\n| createdOn | AssetFunction->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetFunction->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetFunction->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetFunction->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetFunction->ModifiedOn | string | date-time |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetFunction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetFunction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetFunction->PermissionTree_Description | string | |\r\n| assetId | AssetFunction->Asset_Id | integer | int64 |\r\n| assetCode | AssetFunction->Asset_Code | string | |\r\n| assetRecordType | AssetFunction->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetDescription | AssetFunction->Asset_Description | string | |\r\n| assetComponentId | AssetFunction->AssetComponent_Id | integer | int64 |\r\n| assetComponentCode | AssetFunction->AssetComponent_Code | string | |\r\n| assetComponentDescription | AssetFunction->AssetComponent_Description | string | |\r\n| assetComponentRecordType | AssetFunction->AssetComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | AssetFunction->Description | string | |\r\n| inheritedFromId | AssetFunction->InheritedFrom_Id | integer | int64 |\r\n| linkedToEntityType | AssetFunction->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 | AssetFunction->Notes | string | |\r\n", "operationId": "GetAssetFunction", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Function Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Function", "schema": { "$ref": "#/definitions/GetAssetFunctionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Function" ], "summary": "Update an existing Asset 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 | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| sequenceNumber | AssetFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetFunction->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateAssetFunction", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Function Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetFunctionResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset 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" } } }, "delete": { "tags": [ "Asset Function" ], "summary": "Delete an existing Asset 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 | AssetFunction->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": "DeleteAssetFunction", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Function Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDeleteAssetFunctionResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Function 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/PlaceholderAssetComponents/{id}/Functions": { "get": { "tags": [ "Asset Function" ], "summary": "Get a collection of Asset Function for the Placeholder Asset 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 | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| developmentStatus | AssetFunction->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFunction->IsInherited | boolean | |\r\n| inheritedFromId | AssetFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFunctionForPlaceholderAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Function collection", "schema": { "$ref": "#/definitions/GetAssetFunctionForPlaceholderAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/{id}/Functions": { "get": { "tags": [ "Asset Function" ], "summary": "Get a collection of Asset Function for the Regular Asset 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 | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| developmentStatus | AssetFunction->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFunction->IsInherited | boolean | |\r\n| inheritedFromId | AssetFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFunctionForRegularAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Function collection", "schema": { "$ref": "#/definitions/GetAssetFunctionForRegularAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions": { "get": { "tags": [ "Asset Function" ], "summary": "Get a collection of Asset 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 | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| assetCode | AssetFunction->Asset_Code | string | |\r\n| assetRecordType | AssetFunction->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetComponentCode | AssetFunction->AssetComponent_Code | string | |\r\n| assetComponentRecordType | AssetFunction->AssetComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetAssetFunctionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Function collection", "schema": { "$ref": "#/definitions/GetAssetFunctionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset Function" ], "summary": "Create a new Asset 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 | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| assetId | AssetFunction->Asset_Id | integer | int64 |\r\n| assetComponentId | AssetFunction->AssetComponent_Id | integer | int64 |\r\n| permissionTreeId | AssetFunction->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetFunction->Notes | string | |\r\n\r\n#### Business 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| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAssetFunction", "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/CreateAssetFunctionResourceActionResponse" } }, { "$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/RegularAssets/{id}/Functions": { "get": { "tags": [ "Asset Function" ], "summary": "Get a collection of Asset Function for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| developmentStatus | AssetFunction->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFunction->IsInherited | boolean | |\r\n| inheritedFromId | AssetFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFunctionForRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Function collection", "schema": { "$ref": "#/definitions/GetAssetFunctionForRegularAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Functions": { "get": { "tags": [ "Asset Function" ], "summary": "Get a collection of Asset Function for the InPlace Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| developmentStatus | AssetFunction->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFunction->IsInherited | boolean | |\r\n| inheritedFromId | AssetFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFunctionForInPlaceAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Function collection", "schema": { "$ref": "#/definitions/GetAssetFunctionForInPlaceAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/{id}/Functions": { "get": { "tags": [ "Asset Function" ], "summary": "Get a collection of Asset Function for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| developmentStatus | AssetFunction->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AssetFunction->IsInherited | boolean | |\r\n| inheritedFromId | AssetFunction->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAssetFunctionForPlaceholderAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Function collection", "schema": { "$ref": "#/definitions/GetAssetFunctionForPlaceholderAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Lookups/LookupAssetFunctionAssetComponent": { "get": { "tags": [ "Asset Function" ], "summary": "Lookup the Asset Component for the Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| recordType | AssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetFunctionAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/AssetFunctionAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Lookups/LookupAssetFunctionAsset": { "get": { "tags": [ "Asset Function" ], "summary": "Lookup the Asset for the Asset 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 | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetFunctionAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/AssetFunctionAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Lookups/LookupAssetFunctionChangePermissionTree": { "get": { "tags": [ "Asset Function" ], "summary": "Lookup the permission set for changing the Asset 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": "LookupAssetFunctionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFunctionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Lookups/LookupAssetFunctionInsertPermissionTree": { "get": { "tags": [ "Asset Function" ], "summary": "Lookup the permission set for creating the Asset 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": "LookupAssetFunctionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AssetFunctionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Batch/{ids}": { "get": { "tags": [ "Asset Function" ], "summary": "Get a collection of Asset 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 | AssetFunction->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AssetFunction->Id | integer | int64 |\r\n| isActive | AssetFunction->IsActive | boolean | |\r\n| isHistorical | AssetFunction->IsHistorical | boolean | |\r\n| isInherited | AssetFunction->IsInherited | boolean | |\r\n| isProposed | AssetFunction->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AssetFunction->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AssetFunction->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AssetFunction->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AssetFunction->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AssetFunction->Unsynchronised | boolean | |\r\n| code | AssetFunction->Code | string | |\r\n| createdByUserId | AssetFunction->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetFunction->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetFunction->CreatedByUser_FullName | string | |\r\n| createdOn | AssetFunction->CreatedOn | string | date-time |\r\n| modifiedByUserId | AssetFunction->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetFunction->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetFunction->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetFunction->ModifiedOn | string | date-time |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetFunction->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetFunction->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetFunction->PermissionTree_Description | string | |\r\n| assetId | AssetFunction->Asset_Id | integer | int64 |\r\n| assetCode | AssetFunction->Asset_Code | string | |\r\n| assetRecordType | AssetFunction->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetDescription | AssetFunction->Asset_Description | string | |\r\n| assetComponentId | AssetFunction->AssetComponent_Id | integer | int64 |\r\n| assetComponentCode | AssetFunction->AssetComponent_Code | string | |\r\n| assetComponentDescription | AssetFunction->AssetComponent_Description | string | |\r\n| assetComponentRecordType | AssetFunction->AssetComponent_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | AssetFunction->Description | string | |\r\n| inheritedFromId | AssetFunction->InheritedFrom_Id | integer | int64 |\r\n| linkedToEntityType | AssetFunction->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 | AssetFunction->Notes | string | |\r\n", "operationId": "BatchGetAssetFunction", "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 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 Function collection", "schema": { "$ref": "#/definitions/BatchGetAssetFunctionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Batch": { "post": { "tags": [ "Asset Function" ], "summary": "Create a new collection of Asset 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 | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| assetId | AssetFunction->Asset_Id | integer | int64 |\r\n| assetComponentId | AssetFunction->AssetComponent_Id | integer | int64 |\r\n| permissionTreeId | AssetFunction->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AssetFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetFunction->Notes | string | |\r\n\r\n#### Business 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| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAssetFunction", "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/BatchCreateAssetFunctionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Asset 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 Function" ], "summary": "Update a collection of existing Asset 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 | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| code | AssetFunction->Code | string | |\r\n| description | AssetFunction->Description | string | |\r\n| sequenceNumber | AssetFunction->SequenceNumber | integer | int32 |\r\n| notes | AssetFunction->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| 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": "BatchUpdateAssetFunction", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAssetFunctionResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset 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" } } }, "delete": { "tags": [ "Asset Function" ], "summary": "Delete a collection of existing Asset 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 | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->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": "BatchDeleteAssetFunction", "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/BatchDeleteAssetFunctionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Function 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/AssetFunctions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Function" ], "summary": "Accept the Development Status for an existing Asset Function resource.", "description": "", "operationId": "AcceptAssetFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Function Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Asset Function" ], "summary": "Accept the Development Status for the collection of existing Asset Function resource id's.", "description": "", "operationId": "BatchAcceptAssetFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Function id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Function" ], "summary": "Reject the Development Status for the collection of existing Asset Function resource id's.", "description": "", "operationId": "BatchRejectAssetFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Function id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/{id}/Active": { "patch": { "tags": [ "Asset Function" ], "summary": "Change the IsActive status for an existing Asset 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 | AssetFunction->Version | integer | int32 |\r\n| isActive | AssetFunction->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": "ChangeAssetFunctionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Function Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetFunctionIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/{id}/PermissionTree": { "patch": { "tags": [ "Asset Function" ], "summary": "Change the PermissionTree for an existing Asset 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 | AssetFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetFunction->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": "ChangeAssetFunctionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Function Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetFunctionPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Asset Function" ], "summary": "Reject the Development Status for an existing Asset Function resource.", "description": "", "operationId": "RejectAssetFunctionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Function Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetFunctions/Batch/Active": { "patch": { "tags": [ "Asset Function" ], "summary": "Change the IsActive status for a collection of existing Asset 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 | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| isActive | AssetFunction->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": "BatchChangeAssetFunctionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetFunctionIsActiveResourceActionRequest" } }, { "$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/AssetFunctions/Batch/PermissionTree": { "patch": { "tags": [ "Asset Function" ], "summary": "Change the PermissionTree status for a collection of existing Asset 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 | AssetFunction->Id | integer | int64 |\r\n| version | AssetFunction->Version | integer | int32 |\r\n| permissionTreeId | AssetFunction->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": "BatchChangeAssetFunctionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetFunctionPermissionTreeResourceActionRequest" } }, { "$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/AssetTasks/Spares/Lookups/LookupAssetTaskSetWarehouses": { "get": { "tags": [ "Asset Task Spares" ], "summary": "Lookup up the Warehouse", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Warehouse->Id | integer | int64 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n", "operationId": "LookupAssetTaskSetWarehouses", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Warehouse collection", "schema": { "$ref": "#/definitions/SetAssetTaskSpareWarehouseLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTasks/Spares/SetWarehouse/Batch": { "post": { "tags": [ "Asset Task Spares" ], "summary": "Batch set the Warehouse on a collection of Asset Task Spare records.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| warehouseId | SetAssetTaskSpareWarehouseEntity->WarehouseId | integer | int64 |\r\n| assetTaskSpareIds | SetAssetTaskSpareWarehouseEntity->AssetTaskSpareIds | 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| warehouseId | Required | True | |\r\n| warehouseId | Nullable | False | |\r\n| assetTaskSpareIds | Required | True | |\r\n| assetTaskSpareIds | Nullable | False | |\r\n\r\n", "operationId": "BatchSetWarehouse", "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/BatchAssetTaskSpareSetWarehouseResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AssetTasks/Spares/SetWarehouse": { "post": { "tags": [ "Asset Task Spares" ], "summary": "Set the Warehouse on several Asset Task Spare records.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| warehouseId | SetAssetTaskSpareWarehouseEntity->WarehouseId | integer | int64 |\r\n| assetTaskSpareIds | SetAssetTaskSpareWarehouseEntity->AssetTaskSpareIds | 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| warehouseId | Required | True | |\r\n| warehouseId | Nullable | False | |\r\n| assetTaskSpareIds | Required | True | |\r\n| assetTaskSpareIds | Nullable | False | |\r\n\r\n", "operationId": "SetWarehouse", "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/AssetTaskSpareSetWarehouseResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{nodeType}/{id}/PathMap": { "get": { "tags": [ "Asset 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": "GetAssetTreePathMap", "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, 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": "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 Tree collection", "schema": { "$ref": "#/definitions/GetAssetTreePathMapResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/WorkOrders/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Work Order 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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n| assetId | WorkOrder->Asset_Id | integer | int64 |\r\n| assetCode | WorkOrder->Asset_Code | string | |\r\n| assetDescription | WorkOrder->Asset_Description | string | |\r\n| receivedOn | WorkOrder->ReceivedOn | string | date-time |\r\n| requester | WorkOrder->Requester | string | |\r\n| requiredBy | WorkOrder->RequiredBy | string | date-time |\r\n| siteId | WorkOrder->Site_Id | integer | int64 |\r\n| siteCode | WorkOrder->Site_Code | string | |\r\n| staffMemberId | WorkOrder->StaffMember_Id | integer | int64 |\r\n| staffMemberCode | WorkOrder->StaffMember_Code | string | |\r\n| staffMemberContactDetailFullName | WorkOrder->StaffMember_ContactDetailFullName | string | |\r\n| staffMemberDefaultResourceTradeTradeId | WorkOrder->StaffMember_DefaultResourceTrade_Trade_Id | integer | int64 |\r\n| staffMemberDefaultResourceTradeTradeCode | WorkOrder->StaffMember_DefaultResourceTrade_Trade_Code | string | |\r\n| staffMemberDefaultResourceTradeTradeDescription | WorkOrder->StaffMember_DefaultResourceTrade_Trade_Description | string | |\r\n| statusId | WorkOrder->Status_Id | integer | int64 |\r\n| statusDescription | WorkOrder->Status_Description | string | |\r\n| statusBaseStatus | WorkOrder->Status_BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n| typeOfWorkId | WorkOrder->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkWorkClass | WorkOrder->TypeOfWork_WorkClass | string (Allowed values: [NonTactical, Tactical, OperationalWork, ContinuousImprovement, AdministrativeWork]) | enum |\r\n| typeOfWorkDescription | WorkOrder->TypeOfWork_Description | string | |\r\n| version | WorkOrder->Version | integer | int32 |\r\n", "operationId": "GetTreeWorkOrderRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeWorkOrderRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| unsynchronised | RegularAsset->Unsynchronised | boolean | |\r\n", "operationId": "GetAssetTreeRoot", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/AssetComponents/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| version | AssetComponent->Version | integer | int32 |\r\n| description | AssetComponent->Description | string | |\r\n| alternativeDescription | AssetComponent->AlternativeDescription | string | |\r\n| isActive | AssetComponent->IsActive | boolean | |\r\n| sequenceNumber | AssetComponent->SequenceNumber | integer | int32 |\r\n| partNumber | AssetComponent->PartNumber | string | |\r\n| rFId | AssetComponent->RFId | string | |\r\n| qRCode | AssetComponent->QRCode | string | |\r\n| specification | AssetComponent->Specification | string | |\r\n| supplierPartNumber | AssetComponent->SupplierPartNumber | string | |\r\n| recordType | AssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | AssetComponent->Quantity | integer | int32 |\r\n| serialNumber | AssetComponent->SerialNumber | string | |\r\n| supplierId | AssetComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | AssetComponent->Supplier_Code | string | |\r\n| supplierDescription | AssetComponent->Supplier_Description | string | |\r\n| parentComponentId | AssetComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | AssetComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | AssetComponent->ParentComponent_Description | string | |\r\n| assetId | AssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | AssetComponent->Asset_Code | string | |\r\n| assetDescription | AssetComponent->Asset_Description | string | |\r\n| assetTreePathItems | AssetComponent->Asset_TreePathItems | array | array |\r\n| siteId | AssetComponent->Site_Id | integer | int64 |\r\n| siteCode | AssetComponent->Site_Code | string | |\r\n| siteDescription | AssetComponent->Site_Description | string | |\r\n| assetTypeId | AssetComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AssetComponent->AssetType_Code | string | |\r\n| assetTypeDescription | AssetComponent->AssetType_Description | string | |\r\n| placeholderForAssetTypeId | AssetComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | AssetComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | AssetComponent->PlaceholderForAssetType_Description | string | |\r\n| linkedToAssetTypeId | AssetComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | AssetComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | AssetComponent->LinkedToAssetType_Description | string | |\r\n| isInherited | AssetComponent->IsInherited | boolean | |\r\n| inheritedFromId | AssetComponent->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| treePathItems | AssetComponent->TreePathItems | array | array |\r\n| permissionTreeId | AssetComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetComponent->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAssetComponentRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetComponentRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/Assets/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Asset 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 | Asset->Version | integer | int32 |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| sequenceNumber | Asset->SequenceNumber | integer | int32 |\r\n| serialNumber | Asset->SerialNumber | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| permissionTreeId | Asset->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Asset->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Asset->PermissionTree_Description | string | |\r\n| assetTypeCode | Asset->AssetType_Code | string | |\r\n| siteCode | Asset->Site_Code | string | |\r\n| parentAssetCode | Asset->ParentAsset_Code | string | |\r\n| parentAssetDescription | Asset->ParentAsset_Description | string | |\r\n| isMsi | Asset->IsMsi | boolean | |\r\n| treePathItems | Asset->TreePathItems | array | array |\r\n| developmentStatus | Asset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| createdOn | Asset->CreatedOn | string | date-time |\r\n| modifiedOn | Asset->ModifiedOn | string | date-time |\r\n", "operationId": "GetTreeAssetsRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetsRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/AssetTaskResources/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Asset 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 | AssetTaskResource->Id | integer | int64 |\r\n| version | AssetTaskResource->Version | integer | int32 |\r\n| isActive | AssetTaskResource->IsActive | boolean | |\r\n| assetTaskId | AssetTaskResource->AssetTask_Id | integer | int64 |\r\n| assetTaskCode | AssetTaskResource->AssetTask_Code | string | |\r\n| assetTaskDescription | AssetTaskResource->AssetTask_Description | string | |\r\n| assetTaskRecordType | AssetTaskResource->AssetTask_RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| assetTaskAssetId | AssetTaskResource->AssetTask_Asset_Id | integer | int64 |\r\n| assetTaskAssetCode | AssetTaskResource->AssetTask_Asset_Code | string | |\r\n| assetTaskAssetDescription | AssetTaskResource->AssetTask_Asset_Description | string | |\r\n| assetTaskAssetTreePathItems | AssetTaskResource->AssetTask_Asset_TreePathItems | array | array |\r\n| assetTaskComponentId | AssetTaskResource->AssetTask_Component_Id | integer | int64 |\r\n| assetTaskComponentTreePathItems | AssetTaskResource->AssetTask_Component_TreePathItems | array | array |\r\n| resourceId | AssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | AssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceResourceType | AssetTaskResource->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| quantity | AssetTaskResource->Quantity | integer | int32 |\r\n| usage | AssetTaskResource->Usage | object | composite |\r\n| proficiency | AssetTaskResource->Proficiency | integer | int32 |\r\n| sectionId | AssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AssetTaskResource->Section_Code | string | |\r\n| sectionDescription | AssetTaskResource->Section_Description | string | |\r\n| tradeId | AssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | AssetTaskResource->Trade_Description | string | |\r\n| competencyId | AssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | AssetTaskResource->Competency_Description | string | |\r\n| rulesLastEvaluatedOn | AssetTaskResource->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | AssetTaskResource->RuleEvaluationPassed | boolean | |\r\n| sequenceNumber | AssetTaskResource->SequenceNumber | integer | int32 |\r\n| notes | AssetTaskResource->Notes | string | |\r\n| permissionTreeCode | AssetTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTaskResource->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAssetTaskResourcesRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents, AssetTasks, RegularAssetTasks, AuxiliaryAssetTasks]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTaskResourcesRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/AssetTaskSpares/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Asset 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 | AssetTaskSpare->Id | integer | int64 |\r\n| version | AssetTaskSpare->Version | integer | int32 |\r\n| materialMasterId | AssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | AssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AssetTaskSpare->CostElement_Description | string | |\r\n| quantity | AssetTaskSpare->Quantity | number | decimal |\r\n| assetTaskId | AssetTaskSpare->AssetTask_Id | integer | int64 |\r\n| assetTaskCode | AssetTaskSpare->AssetTask_Code | string | |\r\n| assetTaskDescription | AssetTaskSpare->AssetTask_Description | string | |\r\n| assetTaskRecordType | AssetTaskSpare->AssetTask_RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| assetTaskAssetId | AssetTaskSpare->AssetTask_Asset_Id | integer | int64 |\r\n| assetTaskAssetCode | AssetTaskSpare->AssetTask_Asset_Code | string | |\r\n| assetTaskAssetDescription | AssetTaskSpare->AssetTask_Asset_Description | string | |\r\n| assetTaskAssetTreePathItems | AssetTaskSpare->AssetTask_Asset_TreePathItems | array | array |\r\n| assetTaskComponentId | AssetTaskSpare->AssetTask_Component_Id | integer | int64 |\r\n| assetTaskComponentTreePathItems | AssetTaskSpare->AssetTask_Component_TreePathItems | array | array |\r\n| stockItemWarehouseCode | AssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | AssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n| isInherited | AssetTaskSpare->IsInherited | boolean | |\r\n| developmentStatus | AssetTaskSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| rulesLastEvaluatedOn | AssetTaskSpare->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | AssetTaskSpare->RuleEvaluationPassed | boolean | |\r\n| permissionTreeId | AssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTaskSpare->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAssetTaskSparesRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents, AssetTasks, RegularAssetTasks, AuxiliaryAssetTasks]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTaskSparesRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/AssetTasks/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | AssetTask->Id | integer | int64 |\r\n| version | AssetTask->Version | integer | int32 |\r\n| code | AssetTask->Code | string | |\r\n| recordType | AssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| description | AssetTask->Description | string | |\r\n| alternativeDescription | AssetTask->AlternativeDescription | string | |\r\n| isInherited | AssetTask->IsInherited | boolean | |\r\n| isInspection | AssetTask->IsInspection | boolean | |\r\n| isNonUsageBasedReadingRequired | AssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isMandatory | AssetTask->IsMandatory | boolean | |\r\n| defaultInterval1Code | AssetTask->DefaultInterval1_Code | string | |\r\n| rulesLastEvaluatedOn | AssetTask->RulesLastEvaluatedOn | string | date-time |\r\n| inheritedFromId | AssetTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| sequenceNumber | AssetTask->SequenceNumber | integer | int32 |\r\n| assetId | AssetTask->Asset_Id | integer | int64 |\r\n| assetCode | AssetTask->Asset_Code | string | |\r\n| assetDescription | AssetTask->Asset_Description | string | |\r\n| assetTreePathItems | AssetTask->Asset_TreePathItems | array | array |\r\n| componentId | AssetTask->Component_Id | integer | int64 |\r\n| componentCode | AssetTask->Component_Code | string | |\r\n| componentDescription | AssetTask->Component_Description | string | |\r\n| componentRecordType | AssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | AssetTask->Component_TreePathItems | array | array |\r\n| permissionTreeId | AssetTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetTask->PermissionTree_Description | string | |\r\n| ruleEvaluationPassed | AssetTask->RuleEvaluationPassed | boolean | |\r\n| intervalType1Id | AssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | AssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | AssetTask->IntervalType1_Description | string | |\r\n| intervalType2Id | AssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | AssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | AssetTask->IntervalType2_Description | string | |\r\n", "operationId": "GetTreeAssetTasksRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTasksRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/AuxiliaryAssetTasks": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| isActive | AuxiliaryAssetTask->IsActive | boolean | |\r\n| sequenceNumber | AuxiliaryAssetTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | AuxiliaryAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AuxiliaryAssetTask->IsInherited | boolean | |\r\n| recordType | AuxiliaryAssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| assetId | AuxiliaryAssetTask->Asset_Id | integer | int64 |\r\n| componentId | AuxiliaryAssetTask->Component_Id | integer | int64 |\r\n| unsynchronised | AuxiliaryAssetTask->Unsynchronised | boolean | |\r\n", "operationId": "GetTreeAuxiliaryAssetTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssets, InPlaceAssets, PlaceholderAssets, RegularAssetComponents, PlaceholderAssetComponents]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/AuxiliaryAssetTasks/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| recordType | AuxiliaryAssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| isInherited | AuxiliaryAssetTask->IsInherited | boolean | |\r\n| inheritedFromId | AuxiliaryAssetTask->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | AuxiliaryAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| sequenceNumber | AuxiliaryAssetTask->SequenceNumber | integer | int32 |\r\n| assetId | AuxiliaryAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | AuxiliaryAssetTask->Asset_Code | string | |\r\n| assetDescription | AuxiliaryAssetTask->Asset_Description | string | |\r\n| assetTreePathItems | AuxiliaryAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | AuxiliaryAssetTask->Component_Id | integer | int64 |\r\n| componentCode | AuxiliaryAssetTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTask->Component_Description | string | |\r\n| componentRecordType | AuxiliaryAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | AuxiliaryAssetTask->Component_TreePathItems | array | array |\r\n| permissionTreeId | AuxiliaryAssetTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTask->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeAuxiliaryAssetTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeAuxiliaryAssetTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/InPlaceAssets": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAsset->Id | integer | int64 |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | InPlaceAsset->IsInherited | boolean | |\r\n| recordType | InPlaceAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| parentAssetId | InPlaceAsset->ParentAsset_Id | integer | int64 |\r\n| unsynchronised | InPlaceAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationPassed | InPlaceAsset->RuleEvaluationPassed | boolean | |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isActive | InPlaceAsset->IsActive | boolean | |\r\n", "operationId": "GetTreeInPlaceAssetCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssets, InPlaceAssets, PlaceholderAssets]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/PlaceholderAssets": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAsset->Id | integer | int64 |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| isActive | PlaceholderAsset->IsActive | boolean | |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAsset->IsInherited | boolean | |\r\n| recordType | PlaceholderAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| parentAssetId | PlaceholderAsset->ParentAsset_Id | integer | int64 |\r\n| unsynchronised | PlaceholderAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationPassed | PlaceholderAsset->RuleEvaluationPassed | boolean | |\r\n", "operationId": "GetTreePlaceholderAssetCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssets, InPlaceAssets, PlaceholderAssets]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/PlaceholderAssetComponents": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| isActive | PlaceholderAssetComponent->IsActive | boolean | |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| recordType | PlaceholderAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| developmentStatus | PlaceholderAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetComponent->IsInherited | boolean | |\r\n| assetId | PlaceholderAssetComponent->Asset_Id | integer | int64 |\r\n| parentComponentId | PlaceholderAssetComponent->ParentComponent_Id | integer | int64 |\r\n| unsynchronised | PlaceholderAssetComponent->Unsynchronised | boolean | |\r\n| ruleEvaluationPassed | PlaceholderAssetComponent->RuleEvaluationPassed | boolean | |\r\n", "operationId": "GetTreePlaceholderAssetComponentCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssets, InPlaceAssets, PlaceholderAssets, RegularAssetComponents, PlaceholderAssetComponents]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssets": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| isActive | RegularAsset->IsActive | boolean | |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| recordType | RegularAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| unsynchronised | RegularAsset->Unsynchronised | boolean | |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n", "operationId": "GetTreeRegularAssetCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssets, InPlaceAssets, PlaceholderAssets]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetComponents": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| isActive | RegularAssetComponent->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| recordType | RegularAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| developmentStatus | RegularAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetComponent->IsInherited | boolean | |\r\n| assetId | RegularAssetComponent->Asset_Id | integer | int64 |\r\n| parentComponentId | RegularAssetComponent->ParentComponent_Id | integer | int64 |\r\n| unsynchronised | RegularAssetComponent->Unsynchronised | boolean | |\r\n| ruleEvaluationPassed | RegularAssetComponent->RuleEvaluationPassed | boolean | |\r\n", "operationId": "GetTreeRegularAssetComponentCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssets, InPlaceAssets, PlaceholderAssets, RegularAssetComponents, PlaceholderAssetComponents]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTaskAuxiliaryTasks": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskAuxiliaryTask->IsInherited | boolean | |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryTaskAlternativeDescription | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id | integer | int64 |\r\n| unsynchronised | RegularAssetTaskAuxiliaryTask->Unsynchronised | boolean | |\r\n| isActive | RegularAssetTaskAuxiliaryTask->IsActive | boolean | |\r\n", "operationId": "GetTreeRegularAssetTaskAuxiliaryTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTasks]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/RegularAssetTaskAuxiliaryTasks/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Auxiliary Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskAuxiliaryTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTaskId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskComponentId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Component_Id | integer | int64 |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| permissionTreeId | RegularAssetTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskAuxiliaryTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskAuxiliaryTask->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeRegularAssetTaskAuxiliaryTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents, AssetTasks, RegularAssetTasks]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTaskAuxiliaryTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTasks": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| isActive | RegularAssetTask->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTask->IsInherited | boolean | |\r\n| recordType | RegularAssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| unsynchronised | RegularAssetTask->Unsynchronised | boolean | |\r\n| ruleEvaluationPassed | RegularAssetTask->RuleEvaluationPassed | boolean | |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTask->IntervalType2_Description | string | |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTask->DefaultInterval2_Description | string | |\r\n| derivedFromStandardTask | RegularAssetTask->DerivedFromStandardTask | boolean | |\r\n", "operationId": "GetTreeRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssets, InPlaceAssets, PlaceholderAssets, RegularAssetComponents, PlaceholderAssetComponents]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/RegularAssetTaskConditions/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| regularAssetTaskId | RegularAssetTaskCondition->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskCondition->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskCondition->RegularAssetTask_Description | string | |\r\n| regularAssetTaskIntervalType1Id | RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id | integer | int64 |\r\n| regularAssetTaskAssetId | RegularAssetTaskCondition->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskComponentId | RegularAssetTaskCondition->RegularAssetTask_Component_Id | integer | int64 |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| conditionConditionTypeId | RegularAssetTaskCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTaskCondition->Condition_ConditionType_Description | string | |\r\n| conditionCode | RegularAssetTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTaskCondition->Condition_Description | string | |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isInherited | RegularAssetTaskCondition->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| developmentStatus | RegularAssetTaskCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskCondition->Unsynchronised | boolean | |\r\n| lastConfirmedOn | RegularAssetTaskCondition->LastConfirmedOn | string | date-time |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTaskCondition->Interval_Description | string | |\r\n| activeCondition | RegularAssetTaskCondition->ActiveCondition | boolean | |\r\n", "operationId": "GetTreeRegularAssetTaskConditionsRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeAssetTaskConditionsRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTaskFollowUpTasks": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskFollowUpTask->IsInherited | boolean | |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| followUpTaskAlternativeDescription | RegularAssetTaskFollowUpTask->FollowUpTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| unsynchronised | RegularAssetTaskFollowUpTask->Unsynchronised | boolean | |\r\n| isActive | RegularAssetTaskFollowUpTask->IsActive | boolean | |\r\n", "operationId": "GetTreeRegularAssetTaskFollowUpTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTasks]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/RegularAssetTaskFollowUpTasks/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskFollowUpTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTaskId | RegularAssetTaskFollowUpTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskFollowUpTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFollowUpTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetId | RegularAssetTaskFollowUpTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetTreePathItems | RegularAssetTaskFollowUpTask->RegularAssetTask_Asset_TreePathItems | array | array |\r\n| regularAssetTaskComponentId | RegularAssetTaskFollowUpTask->RegularAssetTask_Component_Id | integer | int64 |\r\n| regularAssetTaskComponentTreePathItems | RegularAssetTaskFollowUpTask->RegularAssetTask_Component_TreePathItems | array | array |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFollowUpTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFollowUpTask->PermissionTree_Description | string | |\r\n", "operationId": "GetTreeRegularAssetTaskFollowUpTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents, AssetTasks, RegularAssetTasks]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTaskFollowUpTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/RegularAssetTasks/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isInherited | RegularAssetTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTask->InheritedFrom_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| developmentStatus | RegularAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetTreePathItems | RegularAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTask->Component_TreePathItems | array | array |\r\n| defaultInterval1Code | RegularAssetTask->DefaultInterval1_Code | string | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTask->RulesLastEvaluatedOn | string | date-time |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| importanceCode | RegularAssetTask->Importance_Code | string | |\r\n| importanceDescription | RegularAssetTask->Importance_Description | string | |\r\n| ruleEvaluationPassed | RegularAssetTask->RuleEvaluationPassed | boolean | |\r\n| siteId | RegularAssetTask->Site_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTask->IntervalType2_Description | string | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n", "operationId": "GetTreeRegularAssetTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTaskSuppressedTasks": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskSuppressedTask->IsInherited | boolean | |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| suppressedTaskAlternativeDescription | RegularAssetTaskSuppressedTask->SuppressedTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskSuppressedTask->RegularAssetTask_Id | integer | int64 |\r\n| unsynchronised | RegularAssetTaskSuppressedTask->Unsynchronised | boolean | |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| isActive | RegularAssetTaskSuppressedTask->IsActive | boolean | |\r\n", "operationId": "GetTreeRegularAssetTaskSuppressedTaskCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[RegularAssetTasks]", "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 }, { "type": "boolean", "name": "showRuleEvaluationFailed", "in": "query", "description": "Include records where the rule evaluation failed (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 Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/RegularAssetTaskSuppressedTasks/Recursive": { "get": { "tags": [ "Asset Tree" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskSuppressedTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTaskId | RegularAssetTaskSuppressedTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSuppressedTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSuppressedTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetId | RegularAssetTaskSuppressedTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetTreePathItems | RegularAssetTaskSuppressedTask->RegularAssetTask_Asset_TreePathItems | array | array |\r\n| regularAssetTaskComponentId | RegularAssetTaskSuppressedTask->RegularAssetTask_Component_Id | integer | int64 |\r\n| regularAssetTaskComponentTreePathItems | RegularAssetTaskSuppressedTask->RegularAssetTask_Component_TreePathItems | array | array |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskSuppressedTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskSuppressedTask->PermissionTree_Description | string | |\r\n| developmentStatus | RegularAssetTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n", "operationId": "GetTreeRegularAssetTaskSuppressedTaskRecursiveCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Allowed values:[Assets, RegularAssets, InPlaceAssets, PlaceholderAssets, AssetComponents, RegularAssetComponents, PlaceholderAssetComponents, AssetTasks, RegularAssetTasks]", "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 Tree collection", "schema": { "$ref": "#/definitions/GetTreeRegularAssetTaskSuppressedTaskRecursiveCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/{id}": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Get a Auxiliary Asset 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 | AuxiliaryAssetTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTask->PermissionTree_Description | string | |\r\n| assetId | AuxiliaryAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | AuxiliaryAssetTask->Asset_Code | string | |\r\n| assetDescription | AuxiliaryAssetTask->Asset_Description | string | |\r\n| assetTreePathId | AuxiliaryAssetTask->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | AuxiliaryAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | AuxiliaryAssetTask->Component_Id | integer | int64 |\r\n| componentCode | AuxiliaryAssetTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTask->Component_Description | string | |\r\n| componentQuantity | AuxiliaryAssetTask->Component_Quantity | integer | int32 |\r\n| componentRecordType | AuxiliaryAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetId | AuxiliaryAssetTask->Component_Asset_Id | integer | int64 |\r\n| componentAssetCode | AuxiliaryAssetTask->Component_Asset_Code | string | |\r\n| componentAssetDescription | AuxiliaryAssetTask->Component_Asset_Description | string | |\r\n| componentAssetRecordType | AuxiliaryAssetTask->Component_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathId | AuxiliaryAssetTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | AuxiliaryAssetTask->Component_TreePathItems | array | array |\r\n| developmentStatus | AuxiliaryAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTask->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTask->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTask->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTask->Unsynchronised | boolean | |\r\n| alternativeDescription | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| assetTypeId | AuxiliaryAssetTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AuxiliaryAssetTask->AssetType_Code | string | |\r\n| assetTypeDescription | AuxiliaryAssetTask->AssetType_Description | string | |\r\n| assetTypeTreePathId | AuxiliaryAssetTask->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | AuxiliaryAssetTask->AssetType_TreePathItems | array | array |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| auxiliaryTaskType | AuxiliaryAssetTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| downtimePerUnit | AuxiliaryAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTask->DurationPerUnit | string | duration |\r\n| inheritedFromId | AuxiliaryAssetTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | AuxiliaryAssetTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | AuxiliaryAssetTask->InheritedFrom_Description | string | |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| isSuppressed | AuxiliaryAssetTask->IsSuppressed | boolean | |\r\n| isSuppressor | AuxiliaryAssetTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | AuxiliaryAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| responsibleSectionId | AuxiliaryAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | AuxiliaryAssetTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | AuxiliaryAssetTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceResourceType | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | AuxiliaryAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | AuxiliaryAssetTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | AuxiliaryAssetTask->ResponsibleTrade_Description | string | |\r\n| totalDowntime | AuxiliaryAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTask->TotalDuration | string | duration |\r\n", "operationId": "GetAuxiliaryAssetTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Task", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Task" ], "summary": "Update an existing Auxiliary Asset 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 | AuxiliaryAssetTask->Version | integer | int32 |\r\n| alternativeDescription | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| sequenceNumber | AuxiliaryAssetTask->SequenceNumber | integer | int32 |\r\n| notes | AuxiliaryAssetTask->Notes | string | |\r\n| responsibleTradeId | AuxiliaryAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| labourDurationCalculationType | AuxiliaryAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTask->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 | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\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": "UpdateAuxiliaryAssetTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Auxiliary Asset Task" ], "summary": "Delete an existing Auxiliary Asset 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 | AuxiliaryAssetTask->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": "DeleteAuxiliaryAssetTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Get a collection of Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| developmentStatus | AuxiliaryAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AuxiliaryAssetTask->IsInherited | boolean | |\r\n| permissionTreeCode | AuxiliaryAssetTask->PermissionTree_Code | string | |\r\n| componentId | AuxiliaryAssetTask->Component_Id | integer | int64 |\r\n| componentCode | AuxiliaryAssetTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTask->Component_Description | string | |\r\n| componentTreePathItems | AuxiliaryAssetTask->Component_TreePathItems | array | array |\r\n| assetId | AuxiliaryAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | AuxiliaryAssetTask->Asset_Code | string | |\r\n| assetDescription | AuxiliaryAssetTask->Asset_Description | string | |\r\n| assetTreePathItems | AuxiliaryAssetTask->Asset_TreePathItems | array | array |\r\n| inheritedFromId | AuxiliaryAssetTask->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetAuxiliaryAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Task" ], "summary": "Create a new Auxiliary Asset 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 | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| auxiliaryTaskType | AuxiliaryAssetTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| assetId | AuxiliaryAssetTask->Asset_Id | integer | int64 |\r\n| componentId | AuxiliaryAssetTask->Component_Id | integer | int64 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| labourDurationCalculationType | AuxiliaryAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTask->TotalDuration | string | duration |\r\n| notes | AuxiliaryAssetTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTask->PermissionTree_Id | integer | int64 |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleTradeId | AuxiliaryAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTask->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| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | Min Value | > 1| |\r\n| componentId | 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 | <= 255 chars| |\r\n| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | 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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAuxiliaryAssetTask", "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/CreateAuxiliaryAssetTaskResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/Lookups/LookupAuxiliaryAssetTaskChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Lookup the permission set for changing the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Lookups/LookupAuxiliaryAssetTaskInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Lookup the permission set for creating the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Lookups/LookupAuxiliaryAssetTaskComponent": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Lookup the Asset Component for the Auxiliary Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| quantity | AssetComponent->Quantity | integer | int32 |\r\n", "operationId": "LookupAuxiliaryAssetTaskComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTaskRegularAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Lookups/LookupRegularAuxiliaryAssetTaskAsset": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Lookup the Regular Asset for the Auxiliary Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAuxiliaryAssetTaskAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTaskRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Lookups/LookupAuxiliaryAssetTaskResponsibleSection": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Lookup the Section for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResponsibleSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResponsibleSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Lookups/LookupAuxiliaryAssetTaskResponsibleStaffMemberResource": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Lookup the Resource for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResponsibleStaffMemberResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Lookups/LookupAuxiliaryAssetTaskResponsibleTrade": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Lookup the Trade for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResponsibleTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResponsibleTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Task" ], "summary": "Get a collection of Auxiliary Asset 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 | AuxiliaryAssetTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTask->PermissionTree_Description | string | |\r\n| assetId | AuxiliaryAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | AuxiliaryAssetTask->Asset_Code | string | |\r\n| assetDescription | AuxiliaryAssetTask->Asset_Description | string | |\r\n| assetTreePathId | AuxiliaryAssetTask->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | AuxiliaryAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | AuxiliaryAssetTask->Component_Id | integer | int64 |\r\n| componentCode | AuxiliaryAssetTask->Component_Code | string | |\r\n| componentDescription | AuxiliaryAssetTask->Component_Description | string | |\r\n| componentQuantity | AuxiliaryAssetTask->Component_Quantity | integer | int32 |\r\n| componentRecordType | AuxiliaryAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentAssetId | AuxiliaryAssetTask->Component_Asset_Id | integer | int64 |\r\n| componentAssetCode | AuxiliaryAssetTask->Component_Asset_Code | string | |\r\n| componentAssetDescription | AuxiliaryAssetTask->Component_Asset_Description | string | |\r\n| componentAssetRecordType | AuxiliaryAssetTask->Component_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathId | AuxiliaryAssetTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | AuxiliaryAssetTask->Component_TreePathItems | array | array |\r\n| developmentStatus | AuxiliaryAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTask->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTask->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTask->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTask->Unsynchronised | boolean | |\r\n| alternativeDescription | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| assetTypeId | AuxiliaryAssetTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | AuxiliaryAssetTask->AssetType_Code | string | |\r\n| assetTypeDescription | AuxiliaryAssetTask->AssetType_Description | string | |\r\n| assetTypeTreePathId | AuxiliaryAssetTask->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | AuxiliaryAssetTask->AssetType_TreePathItems | array | array |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| auxiliaryTaskType | AuxiliaryAssetTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| downtimePerUnit | AuxiliaryAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTask->DurationPerUnit | string | duration |\r\n| inheritedFromId | AuxiliaryAssetTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | AuxiliaryAssetTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | AuxiliaryAssetTask->InheritedFrom_Description | string | |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| isSuppressed | AuxiliaryAssetTask->IsSuppressed | boolean | |\r\n| isSuppressor | AuxiliaryAssetTask->IsSuppressor | boolean | |\r\n| labourDurationCalculationType | AuxiliaryAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| notes | AuxiliaryAssetTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| responsibleSectionId | AuxiliaryAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | AuxiliaryAssetTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | AuxiliaryAssetTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceResourceType | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| responsibleStaffMemberResourceContactDetailId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | AuxiliaryAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | AuxiliaryAssetTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | AuxiliaryAssetTask->ResponsibleTrade_Description | string | |\r\n| totalDowntime | AuxiliaryAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTask->TotalDuration | string | duration |\r\n", "operationId": "BatchGetAuxiliaryAssetTask", "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 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 Task collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Batch": { "post": { "tags": [ "Auxiliary Asset Task" ], "summary": "Create a new collection of Auxiliary Asset 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 | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| auxiliaryTaskType | AuxiliaryAssetTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| assetId | AuxiliaryAssetTask->Asset_Id | integer | int64 |\r\n| componentId | AuxiliaryAssetTask->Component_Id | integer | int64 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| labourDurationCalculationType | AuxiliaryAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTask->TotalDuration | string | duration |\r\n| notes | AuxiliaryAssetTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTask->PermissionTree_Id | integer | int64 |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleTradeId | AuxiliaryAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTask->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| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | Min Value | > 1| |\r\n| componentId | 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 | <= 255 chars| |\r\n| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | 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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAuxiliaryAssetTask", "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/BatchCreateAuxiliaryAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Auxiliary Asset 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 Task" ], "summary": "Update a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| alternativeDescription | AuxiliaryAssetTask->AlternativeDescription | string | |\r\n| sequenceNumber | AuxiliaryAssetTask->SequenceNumber | integer | int32 |\r\n| notes | AuxiliaryAssetTask->Notes | string | |\r\n| responsibleTradeId | AuxiliaryAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleStaffMemberResourceId | AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | AuxiliaryAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| labourDurationCalculationType | AuxiliaryAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| autoCalculateDurationPerUnit | AuxiliaryAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | AuxiliaryAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | AuxiliaryAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| downtimePerUnit | AuxiliaryAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | AuxiliaryAssetTask->DurationPerUnit | string | duration |\r\n| totalDowntime | AuxiliaryAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | AuxiliaryAssetTask->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| 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| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\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": "BatchUpdateAuxiliaryAssetTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAuxiliaryAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Auxiliary Asset Task" ], "summary": "Delete a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTask->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": "BatchDeleteAuxiliaryAssetTask", "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/BatchDeleteAuxiliaryAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Task resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Task resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Task resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Task" ], "summary": "Change the IsActive status for an existing Auxiliary Asset 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 | AuxiliaryAssetTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTask->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": "ChangeAuxiliaryAssetTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/AuxiliaryAssetTasks/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset 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 | AuxiliaryAssetTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTask->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": "ChangeAuxiliaryAssetTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/AuxiliaryAssetTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Task resource.", "description": "", "operationId": "RejectAuxiliaryAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Task" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTask->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": "BatchChangeAuxiliaryAssetTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/AuxiliaryAssetTasks/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTask->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": "BatchChangeAuxiliaryAssetTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/AuxiliaryAssetTasks/Resources/{id}": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Get a Auxiliary Asset 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| developmentStatus | AuxiliaryAssetTaskResource->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTaskResource->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTaskResource->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTaskResource->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTaskResource->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTaskResource->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTaskResource->LastConfirmedOn | string | date-time |\r\n| ruleEvaluationFailedReason | AuxiliaryAssetTaskResource->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | AuxiliaryAssetTaskResource->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | AuxiliaryAssetTaskResource->RulesLastEvaluatedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTaskResource->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTaskResource->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTaskResource->Unsynchronised | boolean | |\r\n| createdByUserId | AuxiliaryAssetTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTaskResource->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTaskResource->PermissionTree_Description | string | |\r\n| auxiliaryTaskId | AuxiliaryAssetTaskResource->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | AuxiliaryAssetTaskResource->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | AuxiliaryAssetTaskResource->AuxiliaryTask_Description | string | |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTaskResource->Competency_Description | string | |\r\n| competencyValidityType | AuxiliaryAssetTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | AuxiliaryAssetTaskResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTaskResource->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | AuxiliaryAssetTaskResource->Notes | string | |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| recordType | AuxiliaryAssetTaskResource->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailId | AuxiliaryAssetTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | AuxiliaryAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | AuxiliaryAssetTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | AuxiliaryAssetTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | AuxiliaryAssetTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | AuxiliaryAssetTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n", "operationId": "GetAuxiliaryAssetTaskResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Task Resource", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Update an existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n| notes | AuxiliaryAssetTaskResource->Notes | string | |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | AuxiliaryAssetTaskResource->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| usage | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateAuxiliaryAssetTaskResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Resource was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Delete an existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->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": "DeleteAuxiliaryAssetTaskResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Resource was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Get a collection of Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTaskResource->IsActive | boolean | |\r\n| auxiliaryTaskId | AuxiliaryAssetTaskResource->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | AuxiliaryAssetTaskResource->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | AuxiliaryAssetTaskResource->AuxiliaryTask_Description | string | |\r\n| sequenceNumber | AuxiliaryAssetTaskResource->SequenceNumber | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTaskResource->Trade_Description | string | |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | AuxiliaryAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTaskResource->Competency_Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTaskResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromResourceContactDetailFirstName | AuxiliaryAssetTaskResource->InheritedFrom_Resource_ContactDetailFirstName | string | |\r\n| inheritedFromResourceContactDetailLastName | AuxiliaryAssetTaskResource->InheritedFrom_Resource_ContactDetailLastName | string | |\r\n| notes | AuxiliaryAssetTaskResource->Notes | string | |\r\n| rulesLastEvaluatedOn | AuxiliaryAssetTaskResource->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | AuxiliaryAssetTaskResource->RuleEvaluationPassed | boolean | |\r\n| isInherited | AuxiliaryAssetTaskResource->IsInherited | boolean | |\r\n| developmentStatus | AuxiliaryAssetTaskResource->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| unsynchronised | AuxiliaryAssetTaskResource->Unsynchronised | boolean | |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTaskResource->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n", "operationId": "GetAuxiliaryAssetTaskResourceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task Resource collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Create a new Auxiliary Asset 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| auxiliaryTaskId | AuxiliaryAssetTaskResource->AuxiliaryTask_Id | integer | int64 |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n| notes | AuxiliaryAssetTaskResource->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | AuxiliaryAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | AuxiliaryAssetTaskResource->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| auxiliaryTaskId | Required | True | |\r\n| auxiliaryTaskId | Nullable | False | |\r\n| auxiliaryTaskId | 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": "CreateAuxiliaryAssetTaskResource", "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/CreateAuxiliaryAssetTaskResourceResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/{id}/Resources": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Get a collection of Auxiliary Asset Task Resource resources for the Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTaskResource->Competency_Description | string | |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTaskResource->Trade_Description | string | |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n| developmentStatus | AuxiliaryAssetTaskResource->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| isInherited | AuxiliaryAssetTaskResource->IsInherited | boolean | |\r\n", "operationId": "GetAuxiliaryAssetTaskResourceForAuxiliaryAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset 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 Task Resource collection", "schema": { "$ref": "#/definitions/GetResourceForAuxiliaryAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceAuxiliaryAssetTask": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the Auxiliary Asset Task Resource for the Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTaskResourceAuxiliaryAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTaskResourceTaskAuxiliaryAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the permission set for changing the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceCompetency": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the Competency for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceCompetency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceCompetencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the permission set for creating the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceResource": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the Resource for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceSection": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the Section for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceTradeFinancialRateUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceTrade": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the Trade for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Lookups/LookupAuxiliaryAssetTaskResourceUnitOfMeasurement": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Lookup the for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskResourceUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskResourceUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Get a collection of Auxiliary Asset 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| developmentStatus | AuxiliaryAssetTaskResource->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTaskResource->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTaskResource->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTaskResource->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTaskResource->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTaskResource->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTaskResource->LastConfirmedOn | string | date-time |\r\n| ruleEvaluationFailedReason | AuxiliaryAssetTaskResource->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | AuxiliaryAssetTaskResource->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | AuxiliaryAssetTaskResource->RulesLastEvaluatedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTaskResource->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTaskResource->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTaskResource->Unsynchronised | boolean | |\r\n| createdByUserId | AuxiliaryAssetTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTaskResource->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTaskResource->PermissionTree_Description | string | |\r\n| auxiliaryTaskId | AuxiliaryAssetTaskResource->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | AuxiliaryAssetTaskResource->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | AuxiliaryAssetTaskResource->AuxiliaryTask_Description | string | |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | AuxiliaryAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | AuxiliaryAssetTaskResource->Competency_Description | string | |\r\n| competencyValidityType | AuxiliaryAssetTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | AuxiliaryAssetTaskResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTaskResource->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | AuxiliaryAssetTaskResource->Notes | string | |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| recordType | AuxiliaryAssetTaskResource->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | AuxiliaryAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailId | AuxiliaryAssetTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | AuxiliaryAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | AuxiliaryAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | AuxiliaryAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | AuxiliaryAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | AuxiliaryAssetTaskResource->Section_Description | string | |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | AuxiliaryAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | AuxiliaryAssetTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | AuxiliaryAssetTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | AuxiliaryAssetTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | AuxiliaryAssetTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | AuxiliaryAssetTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n", "operationId": "BatchGetAuxiliaryAssetTaskResource", "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 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 Task Resource collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTaskResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Batch": { "post": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Create a new collection of Auxiliary Asset 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| auxiliaryTaskId | AuxiliaryAssetTaskResource->AuxiliaryTask_Id | integer | int64 |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n| notes | AuxiliaryAssetTaskResource->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | AuxiliaryAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | AuxiliaryAssetTaskResource->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| auxiliaryTaskId | Required | True | |\r\n| auxiliaryTaskId | Nullable | False | |\r\n| auxiliaryTaskId | 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": "BatchCreateAuxiliaryAssetTaskResource", "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/BatchCreateAuxiliaryAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Auxiliary Asset 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 Task Resource" ], "summary": "Update a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| competencyId | AuxiliaryAssetTaskResource->Competency_Id | integer | int64 |\r\n| usage | AuxiliaryAssetTaskResource->Usage | object | composite |\r\n| notes | AuxiliaryAssetTaskResource->Notes | string | |\r\n| proficiency | AuxiliaryAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | AuxiliaryAssetTaskResource->Quantity | integer | int32 |\r\n| resourceId | AuxiliaryAssetTaskResource->Resource_Id | integer | int64 |\r\n| sectionId | AuxiliaryAssetTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | AuxiliaryAssetTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | AuxiliaryAssetTaskResource->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| usage | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateAuxiliaryAssetTaskResource", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAuxiliaryAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Resource batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Delete a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskResource->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": "BatchDeleteAuxiliaryAssetTaskResource", "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/BatchDeleteAuxiliaryAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Resource batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Task Resource resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Task Resource resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Task Resource resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Change the IsActive status for an existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTaskResource->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": "ChangeAuxiliaryAssetTaskResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskResourceIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskResource->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": "ChangeAuxiliaryAssetTaskResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskResourcePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Task Resource resource.", "description": "", "operationId": "RejectAuxiliaryAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Resources/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTaskResource->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": "BatchChangeAuxiliaryAssetTaskResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskResourceIsActiveResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/Resources/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task Resource" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskResource->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskResource->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": "BatchChangeAuxiliaryAssetTaskResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskResourcePermissionTreeResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/Spares/{id}": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Get a Auxiliary Asset 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| developmentStatus | AuxiliaryAssetTaskSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTaskSpare->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTaskSpare->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTaskSpare->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTaskSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTaskSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTaskSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTaskSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTaskSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTaskSpare->Unsynchronised | boolean | |\r\n| createdByUserId | AuxiliaryAssetTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTaskSpare->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTaskSpare->PermissionTree_Description | string | |\r\n| auxiliaryAssetTaskId | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id | integer | int64 |\r\n| auxiliaryAssetTaskCode | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Code | string | |\r\n| auxiliaryAssetTaskDescription | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Description | string | |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTaskSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromPreferredMaterialMasterId | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id | integer | int64 |\r\n| inheritedFromPreferredMaterialMasterCode | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code | string | |\r\n| inheritedFromPreferredMaterialMasterDescription | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description | string | |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | AuxiliaryAssetTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n| recordType | AuxiliaryAssetTaskSpare->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| stockItemId | AuxiliaryAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | AuxiliaryAssetTaskSpare->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | AuxiliaryAssetTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n", "operationId": "GetAuxiliaryAssetTaskSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Task Spare", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Update an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| stockItemId | AuxiliaryAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTaskSpare->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| stockItemId | Nullable | False | |\r\n| materialMasterId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateAuxiliaryAssetTaskSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Spare was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Delete an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->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": "DeleteAuxiliaryAssetTaskSpare", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Spare was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Get a collection of Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| inheritedFromPreferredMaterialMasterId | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id | integer | int64 |\r\n| inheritedFromPreferredMaterialMasterCode | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code | string | |\r\n| inheritedFromPreferredMaterialMasterDescription | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description | string | |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTaskSpare->CostElement_Description | string | |\r\n| developmentStatus | AuxiliaryAssetTaskSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AuxiliaryAssetTaskSpare->IsInherited | boolean | |\r\n| auxiliaryAssetTaskId | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id | integer | int64 |\r\n| auxiliaryAssetTaskCode | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Code | string | |\r\n| auxiliaryAssetTaskDescription | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Description | string | |\r\n| auxiliaryAssetTaskAssetTreePathItems | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Asset_TreePathItems | array | array |\r\n| auxiliaryAssetTaskComponentTreePathItems | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Component_TreePathItems | array | array |\r\n| stockItemWarehouseCode | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetAuxiliaryAssetTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task Spare collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Create a new Auxiliary Asset 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| auxiliaryAssetTaskId | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id | integer | int64 |\r\n| stockItemId | AuxiliaryAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | AuxiliaryAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTaskSpare->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| auxiliaryAssetTaskId | Required | True | |\r\n| auxiliaryAssetTaskId | Nullable | False | |\r\n| auxiliaryAssetTaskId | Min Value | > 0| |\r\n| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n| materialMasterId | System Generated | true | If no value specified |\r\n| materialMasterId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "CreateAuxiliaryAssetTaskSpare", "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/CreateAuxiliaryAssetTaskSpareResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/{id}/Spares": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Get a collection of Auxiliary Asset Task Spare resources for the Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTaskSpare->CostElement_Description | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n", "operationId": "GetAuxiliaryAssetTaskSpareForAuxiliaryAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset 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 Task Spare collection", "schema": { "$ref": "#/definitions/GetSpareForAuxiliaryAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareAuxiliaryAssetTask": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the Auxiliary Asset Task Spare for the Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTaskSpareAuxiliaryAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTaskSpareTaskAuxiliaryAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the permission set for changing the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareCommodity": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the Commodity for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskSpareCommodity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSpareCommodityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareCostElement": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the Cost Element for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskSpareCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSpareCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the permission set for creating the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareMaterialMasterForCommodity": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the Material Master for the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskSpareMaterialMasterForCommodity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareMaterialMaster": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the Material Master for the Auxiliary Asset 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| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n", "operationId": "LookupAuxiliaryAssetTaskSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareStockItemForMaterialMaster": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the Stock Item for the Auxiliary Asset Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterCommodityId | StockItem->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StockItem->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StockItem->MaterialMaster_Commodity_Description | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTaskSpareStockItemForMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Stock Item collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Lookups/LookupAuxiliaryAssetTaskSpareStockItem": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Lookup the Stock Item for the Auxiliary Asset Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterDescription | StockItem->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | StockItem->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StockItem->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StockItem->MaterialMaster_Commodity_Description | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n", "operationId": "LookupAuxiliaryAssetTaskSpareStockItem", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Stock Item collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTaskSpareStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Get a collection of Auxiliary Asset 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| developmentStatus | AuxiliaryAssetTaskSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTaskSpare->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTaskSpare->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTaskSpare->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTaskSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTaskSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTaskSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTaskSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTaskSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTaskSpare->Unsynchronised | boolean | |\r\n| createdByUserId | AuxiliaryAssetTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTaskSpare->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTaskSpare->PermissionTree_Description | string | |\r\n| auxiliaryAssetTaskId | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id | integer | int64 |\r\n| auxiliaryAssetTaskCode | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Code | string | |\r\n| auxiliaryAssetTaskDescription | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Description | string | |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | AuxiliaryAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | AuxiliaryAssetTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTaskSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromPreferredMaterialMasterId | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id | integer | int64 |\r\n| inheritedFromPreferredMaterialMasterCode | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code | string | |\r\n| inheritedFromPreferredMaterialMasterDescription | AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description | string | |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | AuxiliaryAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | AuxiliaryAssetTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n| recordType | AuxiliaryAssetTaskSpare->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| stockItemId | AuxiliaryAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemMaterialMasterId | AuxiliaryAssetTaskSpare->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | AuxiliaryAssetTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | AuxiliaryAssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n", "operationId": "BatchGetAuxiliaryAssetTaskSpare", "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 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 Task Spare collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTaskSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Batch": { "post": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Create a new collection of Auxiliary Asset 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| auxiliaryAssetTaskId | AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id | integer | int64 |\r\n| stockItemId | AuxiliaryAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| permissionTreeId | AuxiliaryAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTaskSpare->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| auxiliaryAssetTaskId | Required | True | |\r\n| auxiliaryAssetTaskId | Nullable | False | |\r\n| auxiliaryAssetTaskId | Min Value | > 0| |\r\n| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n| materialMasterId | System Generated | true | If no value specified |\r\n| materialMasterId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateAuxiliaryAssetTaskSpare", "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/BatchCreateAuxiliaryAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Auxiliary Asset 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 Task Spare" ], "summary": "Update a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| stockItemId | AuxiliaryAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| materialMasterId | AuxiliaryAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| costElementId | AuxiliaryAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | AuxiliaryAssetTaskSpare->Notes | string | |\r\n| quantity | AuxiliaryAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | AuxiliaryAssetTaskSpare->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| stockItemId | Nullable | False | |\r\n| materialMasterId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateAuxiliaryAssetTaskSpare", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAuxiliaryAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Spare batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Delete a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSpare->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteAuxiliaryAssetTaskSpare", "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/BatchDeleteAuxiliaryAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Spare batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Task Spare resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Task Spare resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Task Spare resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Change the IsActive status for an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTaskSpare->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": "ChangeAuxiliaryAssetTaskSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSpareIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSpare->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": "ChangeAuxiliaryAssetTaskSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSparePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Task Spare resource.", "description": "", "operationId": "RejectAuxiliaryAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/Spares/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTaskSpare->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": "BatchChangeAuxiliaryAssetTaskSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskSpareIsActiveResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task Spare" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSpare->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSpare->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": "BatchChangeAuxiliaryAssetTaskSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskSparePermissionTreeResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/SubTasks/{id}": { "get": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Get a Auxiliary Asset 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| developmentStatus | AuxiliaryAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTaskSubTask->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTaskSubTask->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTaskSubTask->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTaskSubTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTaskSubTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTaskSubTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTaskSubTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTaskSubTask->Unsynchronised | boolean | |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTaskSubTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTaskSubTask->PermissionTree_Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->AlternativeDescription | string | |\r\n| auxiliaryAssetTaskId | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id | integer | int64 |\r\n| auxiliaryAssetTaskCode | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Code | string | |\r\n| auxiliaryAssetTaskDescription | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Description | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTaskSubTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | AuxiliaryAssetTaskSubTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTaskSubTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n", "operationId": "GetAuxiliaryAssetTaskSubTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Auxiliary Asset Task Sub Task", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskSubTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Update an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| sequenceNumber | AuxiliaryAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| notes | AuxiliaryAssetTaskSubTask->Notes | string | |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->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": "UpdateAuxiliaryAssetTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset 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" } } }, "delete": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Delete an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->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": "DeleteAuxiliaryAssetTaskSubTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Sub Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks": { "get": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Get a collection of Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| auxiliaryAssetTaskId | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id | integer | int64 |\r\n| auxiliaryAssetTaskCode | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Code | string | |\r\n| auxiliaryAssetTaskDescription | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Description | string | |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->AlternativeDescription | string | |\r\n| developmentStatus | AuxiliaryAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AuxiliaryAssetTaskSubTask->IsInherited | boolean | |\r\n", "operationId": "GetAuxiliaryAssetTaskSubTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task Sub Task collection", "schema": { "$ref": "#/definitions/GetAuxiliaryAssetTaskSubTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Create a new Auxiliary Asset 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| auxiliaryAssetTaskId | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id | integer | int64 |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->AlternativeDescription | string | |\r\n| notes | AuxiliaryAssetTaskSubTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTaskSubTask->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| auxiliaryAssetTaskId | Required | True | |\r\n| auxiliaryAssetTaskId | Nullable | False | |\r\n| auxiliaryAssetTaskId | 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 | 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": "CreateAuxiliaryAssetTaskSubTask", "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/CreateAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/{id}/SubTasks": { "get": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Get a collection of Auxiliary Asset Task Sub Task resources for the Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->AlternativeDescription | string | |\r\n| developmentStatus | AuxiliaryAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AuxiliaryAssetTaskSubTask->IsInherited | boolean | |\r\n", "operationId": "GetAuxiliaryAssetTaskSubTaskForAuxiliaryAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset 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 Task Sub Task collection", "schema": { "$ref": "#/definitions/GetSubTaskForAuxiliaryAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Lookups/LookupAuxiliaryAssetTaskSubTaskAuxiliaryAssetTask": { "get": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Lookup the Auxiliary Asset Task Sub Task for the Auxiliary Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| componentCode | AuxiliaryAssetTask->Component_Code | string | |\r\n| componentTreePathItems | AuxiliaryAssetTask->Component_TreePathItems | array | array |\r\n| assetCode | AuxiliaryAssetTask->Asset_Code | string | |\r\n| assetTreePathItems | AuxiliaryAssetTask->Asset_TreePathItems | array | array |\r\n| developmentStatus | AuxiliaryAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | AuxiliaryAssetTask->IsInherited | boolean | |\r\n", "operationId": "LookupAuxiliaryAssetTaskSubTaskAuxiliaryAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task collection", "schema": { "$ref": "#/definitions/AuxiliaryAssetTaskSubTaskTaskAuxiliaryAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Lookups/LookupAuxiliaryAssetTaskSubTaskChangePermissionTree": { "get": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Lookup the permission set for changing the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskSubTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Lookups/LookupAuxiliaryAssetTaskSubTaskInsertPermissionTree": { "get": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Lookup the permission set for creating the Auxiliary Asset 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": "LookupAuxiliaryAssetTaskSubTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/AuxiliaryAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Batch/{ids}": { "get": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Get a collection of Auxiliary Asset 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| developmentStatus | AuxiliaryAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| isActive | AuxiliaryAssetTaskSubTask->IsActive | boolean | |\r\n| isHistorical | AuxiliaryAssetTaskSubTask->IsHistorical | boolean | |\r\n| isInherited | AuxiliaryAssetTaskSubTask->IsInherited | boolean | |\r\n| isProposed | AuxiliaryAssetTaskSubTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | AuxiliaryAssetTaskSubTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | AuxiliaryAssetTaskSubTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | AuxiliaryAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | AuxiliaryAssetTaskSubTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | AuxiliaryAssetTaskSubTask->Unsynchronised | boolean | |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| createdByUserId | AuxiliaryAssetTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AuxiliaryAssetTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AuxiliaryAssetTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | AuxiliaryAssetTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AuxiliaryAssetTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AuxiliaryAssetTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AuxiliaryAssetTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AuxiliaryAssetTaskSubTask->ModifiedOn | string | date-time |\r\n| version | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AuxiliaryAssetTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AuxiliaryAssetTaskSubTask->PermissionTree_Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->AlternativeDescription | string | |\r\n| auxiliaryAssetTaskId | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id | integer | int64 |\r\n| auxiliaryAssetTaskCode | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Code | string | |\r\n| auxiliaryAssetTaskDescription | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Description | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| inheritedFromId | AuxiliaryAssetTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | AuxiliaryAssetTaskSubTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | AuxiliaryAssetTaskSubTask->Notes | string | |\r\n| recordType | AuxiliaryAssetTaskSubTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n", "operationId": "BatchGetAuxiliaryAssetTaskSubTask", "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 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 Task Sub Task collection", "schema": { "$ref": "#/definitions/BatchGetAuxiliaryAssetTaskSubTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Batch": { "post": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Create a new collection of Auxiliary Asset 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| auxiliaryAssetTaskId | AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id | integer | int64 |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->AlternativeDescription | string | |\r\n| notes | AuxiliaryAssetTaskSubTask->Notes | string | |\r\n| permissionTreeId | AuxiliaryAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AuxiliaryAssetTaskSubTask->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| auxiliaryAssetTaskId | Required | True | |\r\n| auxiliaryAssetTaskId | Nullable | False | |\r\n| auxiliaryAssetTaskId | 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 | 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": "BatchCreateAuxiliaryAssetTaskSubTask", "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/BatchCreateAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Auxiliary Asset 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 Task Sub Task" ], "summary": "Update a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| sequenceNumber | AuxiliaryAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| notes | AuxiliaryAssetTaskSubTask->Notes | string | |\r\n| code | AuxiliaryAssetTaskSubTask->Code | string | |\r\n| description | AuxiliaryAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | AuxiliaryAssetTaskSubTask->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": "BatchUpdateAuxiliaryAssetTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset 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" } } }, "delete": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Delete a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSubTask->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": "BatchDeleteAuxiliaryAssetTaskSubTask", "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/BatchDeleteAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Auxiliary Asset Task Sub Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Accept the Development Status for an existing Auxiliary Asset Task Sub Task resource.", "description": "", "operationId": "AcceptAuxiliaryAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Accept the Development Status for the collection of existing Auxiliary Asset Task Sub Task resource id's.", "description": "", "operationId": "BatchAcceptAuxiliaryAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Reject the Development Status for the collection of existing Auxiliary Asset Task Sub Task resource id's.", "description": "", "operationId": "BatchRejectAuxiliaryAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Auxiliary Asset Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/{id}/Active": { "patch": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Change the IsActive status for an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTaskSubTask->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": "ChangeAuxiliaryAssetTaskSubTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSubTaskIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/{id}/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Change the PermissionTree for an existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSubTask->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": "ChangeAuxiliaryAssetTaskSubTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSubTaskPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Reject the Development Status for an existing Auxiliary Asset Task Sub Task resource.", "description": "", "operationId": "RejectAuxiliaryAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Auxiliary Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/AuxiliaryAssetTasks/SubTasks/Batch/Active": { "patch": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Change the IsActive status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| isActive | AuxiliaryAssetTaskSubTask->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": "BatchChangeAuxiliaryAssetTaskSubTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskSubTaskIsActiveResourceActionRequest" } }, { "$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/AuxiliaryAssetTasks/SubTasks/Batch/PermissionTree": { "patch": { "tags": [ "Auxiliary Asset Task Sub Task" ], "summary": "Change the PermissionTree status for a collection of existing Auxiliary Asset 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 | AuxiliaryAssetTaskSubTask->Id | integer | int64 |\r\n| version | AuxiliaryAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | AuxiliaryAssetTaskSubTask->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": "BatchChangeAuxiliaryAssetTaskSubTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAuxiliaryAssetTaskSubTaskPermissionTreeResourceActionRequest" } }, { "$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/InPlaceAssets/{id}": { "get": { "tags": [ "In-Place Asset" ], "summary": "Get a In-Place Asset 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| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | InPlaceAsset->Calendar_Code | string | |\r\n| calendarDescription | InPlaceAsset->Calendar_Description | string | |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAsset->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAsset->CostCentre_Description | string | |\r\n| developmentStatus | InPlaceAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAsset->GeneralLedger_Description | string | |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| isActive | InPlaceAsset->IsActive | boolean | |\r\n| isHistorical | InPlaceAsset->IsHistorical | boolean | |\r\n| isInherited | InPlaceAsset->IsInherited | boolean | |\r\n| isProposed | InPlaceAsset->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAsset->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAsset->LastConfirmedOn | string | date-time |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAsset->Location_Code | string | |\r\n| locationDescription | InPlaceAsset->Location_Description | string | |\r\n| nearestRegularAssetId | InPlaceAsset->NearestRegularAsset_Id | integer | int64 |\r\n| parentAssetId | InPlaceAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | InPlaceAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | InPlaceAsset->ParentAsset_Description | string | |\r\n| parentAssetRecordType | InPlaceAsset->ParentAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| siteId | InPlaceAsset->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAsset->Site_Code | string | |\r\n| siteDescription | InPlaceAsset->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAsset->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | InPlaceAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationFailedReason | InPlaceAsset->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | InPlaceAsset->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | InPlaceAsset->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | InPlaceAsset->Unsubscribed | boolean | |\r\n| code | InPlaceAsset->Code | string | |\r\n| geographicId | InPlaceAsset->GeographicId | integer | int64 |\r\n| geographicEndPosition | InPlaceAsset->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | InPlaceAsset->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | InPlaceAsset->GeographicLength | number | decimal |\r\n| geographicLocation | InPlaceAsset->GeographicLocation | object | |\r\n| geographicNotes | InPlaceAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityId | InPlaceAsset->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | InPlaceAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | InPlaceAsset->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | InPlaceAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | InPlaceAsset->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | InPlaceAsset->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | InPlaceAsset->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAsset->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAsset->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAsset->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAsset->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAsset->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAsset->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAsset->ModifiedOn | string | date-time |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAsset->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAsset->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAsset->PermissionTree_Description | string | |\r\n| treePathId | InPlaceAsset->TreePathId | integer | int64 |\r\n| treePathItems | InPlaceAsset->TreePathItems | array | array |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | InPlaceAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | InPlaceAsset->AcquisitionStatus_Description | string | |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | InPlaceAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | InPlaceAsset->AcquisitionType_Description | string | |\r\n| alternativeDescription | InPlaceAsset->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | InPlaceAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | InPlaceAsset->AssetImportance_Description | string | |\r\n| assetTypeId | InPlaceAsset->AssetType_Id | integer | int64 |\r\n| assetTypeCode | InPlaceAsset->AssetType_Code | string | |\r\n| assetTypeDescription | InPlaceAsset->AssetType_Description | string | |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | InPlaceAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | InPlaceAsset->CommissioningWorkOrder_Description | string | |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| description | InPlaceAsset->Description | string | |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| inheritedFromId | InPlaceAsset->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | InPlaceAsset->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isPermitRequired | InPlaceAsset->IsPermitRequired | boolean | |\r\n| isRunning | InPlaceAsset->IsRunning | boolean | |\r\n| notes | InPlaceAsset->Notes | string | |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| recordType | InPlaceAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | InPlaceAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | InPlaceAsset->ReplacementAsset_Description | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | InPlaceAsset->Supplier_Code | string | |\r\n| supplierDescription | InPlaceAsset->Supplier_Description | string | |\r\n| taskRollUpPointId | InPlaceAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | InPlaceAsset->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | InPlaceAsset->TaskRollUpPoint_Description | string | |\r\n| warranty | InPlaceAsset->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetInPlaceAsset", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset", "schema": { "$ref": "#/definitions/GetInPlaceAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset" ], "summary": "Update an existing In-Place Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| alternativeDescription | InPlaceAsset->AlternativeDescription | string | |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| isPermitRequired | InPlaceAsset->IsPermitRequired | boolean | |\r\n| isRunning | InPlaceAsset->IsRunning | boolean | |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| notes | InPlaceAsset->Notes | string | |\r\n| geographicLocation | InPlaceAsset->GeographicLocation | object | |\r\n| geographicStartPosition | InPlaceAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | InPlaceAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | InPlaceAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | InPlaceAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | InPlaceAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | InPlaceAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | InPlaceAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Read-only | True | InPlaceAsset->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 | InPlaceAsset->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| isMsi | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| calendarId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateInPlaceAsset", "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 Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-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": [ "In-Place Asset" ], "summary": "Delete an existing In-Place Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAsset->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": "DeleteInPlaceAsset", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteInPlaceAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset 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/InPlaceAssets": { "get": { "tags": [ "In-Place Asset" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAsset->Version | integer | int32 |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| isActive | InPlaceAsset->IsActive | boolean | |\r\n| siteId | InPlaceAsset->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAsset->Site_Code | string | |\r\n| siteDescription | InPlaceAsset->Site_Description | string | |\r\n| developmentStatus | InPlaceAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | InPlaceAsset->IsInherited | boolean | |\r\n| lastConfirmedOn | InPlaceAsset->LastConfirmedOn | string | date-time |\r\n| parentAssetId | InPlaceAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | InPlaceAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | InPlaceAsset->ParentAsset_Description | string | |\r\n| assetTypeId | InPlaceAsset->AssetType_Id | integer | int64 |\r\n| assetTypeCode | InPlaceAsset->AssetType_Code | string | |\r\n| assetTypeDescription | InPlaceAsset->AssetType_Description | string | |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| recordType | InPlaceAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAsset->Location_Code | string | |\r\n| locationDescription | InPlaceAsset->Location_Description | string | |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | InPlaceAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | InPlaceAsset->AssetImportance_Description | string | |\r\n| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | InPlaceAsset->Calendar_Code | string | |\r\n| calendarDescription | InPlaceAsset->Calendar_Description | string | |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAsset->GeneralLedger_Description | string | |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | InPlaceAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | InPlaceAsset->CommissioningWorkOrder_Description | string | |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAsset->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAsset->CostCentre_Description | string | |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| inheritedFromId | InPlaceAsset->InheritedFrom_Id | integer | int64 |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | InPlaceAsset->Supplier_Code | string | |\r\n| supplierDescription | InPlaceAsset->Supplier_Description | string | |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | InPlaceAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | InPlaceAsset->AcquisitionType_Description | string | |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | InPlaceAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | InPlaceAsset->AcquisitionStatus_Description | string | |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | InPlaceAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | InPlaceAsset->ReplacementAsset_Description | string | |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| notes | InPlaceAsset->Notes | string | |\r\n| rulesLastEvaluatedOn | InPlaceAsset->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | InPlaceAsset->RuleEvaluationPassed | boolean | |\r\n| createdOn | InPlaceAsset->CreatedOn | string | date-time |\r\n| modifiedOn | InPlaceAsset->ModifiedOn | string | date-time |\r\n| treePathItems | InPlaceAsset->TreePathItems | array | array |\r\n", "operationId": "GetInPlaceAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset" ], "summary": "Get a In-Place Asset resource.", "description": "### Request Body\r\n#### 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 | InPlaceAsset->PermissionTree_Id | integer | int64 |\r\n| siteId | InPlaceAsset->Site_Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| alternativeDescription | InPlaceAsset->AlternativeDescription | string | |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| parentAssetId | InPlaceAsset->ParentAsset_Id | integer | int64 |\r\n| isPermitRequired | InPlaceAsset->IsPermitRequired | boolean | |\r\n| isRunning | InPlaceAsset->IsRunning | boolean | |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| notes | InPlaceAsset->Notes | string | |\r\n| geographicLocation | InPlaceAsset->GeographicLocation | object | |\r\n| geographicStartPosition | InPlaceAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | InPlaceAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | InPlaceAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | InPlaceAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | InPlaceAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | InPlaceAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | InPlaceAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | 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| 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| isMsi | Nullable | False | |\r\n| isForScheduledWorkOnly | Required | True | |\r\n| isForScheduledWorkOnly | Nullable | False | |\r\n| parentAssetId | Required | True | |\r\n| parentAssetId | Nullable | False | |\r\n| parentAssetId | Min Value | > 1| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| calendarId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAsset", "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/CreateInPlaceAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetAcquisitionStatus": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Acquisition Status for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AcquisitionStatus->Id | integer | int64 |\r\n| code | AcquisitionStatus->Code | string | |\r\n| description | AcquisitionStatus->Description | string | |\r\n", "operationId": "LookupInPlaceAssetAcquisitionStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Acquisition Status collection", "schema": { "$ref": "#/definitions/InPlaceAssetAcquisitionStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetAcquisitionType": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Acquisition Type for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AcquisitionType->Id | integer | int64 |\r\n| code | AcquisitionType->Code | string | |\r\n| description | AcquisitionType->Description | string | |\r\n", "operationId": "LookupInPlaceAssetAcquisitionType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Acquisition Type collection", "schema": { "$ref": "#/definitions/InPlaceAssetAcquisitionTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetAssetParent": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the In-Place Asset for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupInPlaceAssetAssetParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/InPlaceAssetAssetParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetAssetTypeParent": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the In-Place Asset for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetAssetTypeParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetAssetTypeParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetCalendar": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Calendar for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Calendar->Id | integer | int64 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n", "operationId": "LookupInPlaceAssetCalendar", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Calendar collection", "schema": { "$ref": "#/definitions/InPlaceAssetCalendarLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetChangePermissionTree": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the permission set for changing the In-Place Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetCommissioningWorkOrder": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Work Order for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupInPlaceAssetCommissioningWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Work Order collection", "schema": { "$ref": "#/definitions/InPlaceAssetCommissioningWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetCostCentre": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Cost Centre for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupInPlaceAssetCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/InPlaceAssetCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetGeneralLedger": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the General Ledger for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupInPlaceAssetGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/InPlaceAssetGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetImportance": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Asset Importance for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetInsertPermissionTree": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the permission set for creating the In-Place Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetLocation": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Location for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n", "operationId": "LookupInPlaceAssetLocation", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Location collection", "schema": { "$ref": "#/definitions/InPlaceAssetLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetReplacementAsset": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Replacement Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n", "operationId": "LookupInPlaceAssetReplacementAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/InPlaceAssetReplacementAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetSite": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Site for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupInPlaceAssetSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/InPlaceAssetSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceAssetSupplier": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Supplier for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Lookups/LookupInPlaceRegularAssetTaskRollUpPoint": { "get": { "tags": [ "In-Place Asset" ], "summary": "Lookup the Task Roll Up Point for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceRegularAssetTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceRegularAssetTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Batch/{ids}": { "get": { "tags": [ "In-Place Asset" ], "summary": "Get a collection of In-Place Asset 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| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | InPlaceAsset->Calendar_Code | string | |\r\n| calendarDescription | InPlaceAsset->Calendar_Description | string | |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAsset->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAsset->CostCentre_Description | string | |\r\n| developmentStatus | InPlaceAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAsset->GeneralLedger_Description | string | |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| isActive | InPlaceAsset->IsActive | boolean | |\r\n| isHistorical | InPlaceAsset->IsHistorical | boolean | |\r\n| isInherited | InPlaceAsset->IsInherited | boolean | |\r\n| isProposed | InPlaceAsset->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAsset->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAsset->LastConfirmedOn | string | date-time |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAsset->Location_Code | string | |\r\n| locationDescription | InPlaceAsset->Location_Description | string | |\r\n| nearestRegularAssetId | InPlaceAsset->NearestRegularAsset_Id | integer | int64 |\r\n| parentAssetId | InPlaceAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | InPlaceAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | InPlaceAsset->ParentAsset_Description | string | |\r\n| parentAssetRecordType | InPlaceAsset->ParentAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| siteId | InPlaceAsset->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAsset->Site_Code | string | |\r\n| siteDescription | InPlaceAsset->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAsset->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | InPlaceAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationFailedReason | InPlaceAsset->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | InPlaceAsset->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | InPlaceAsset->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | InPlaceAsset->Unsubscribed | boolean | |\r\n| code | InPlaceAsset->Code | string | |\r\n| geographicId | InPlaceAsset->GeographicId | integer | int64 |\r\n| geographicEndPosition | InPlaceAsset->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | InPlaceAsset->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | InPlaceAsset->GeographicLength | number | decimal |\r\n| geographicLocation | InPlaceAsset->GeographicLocation | object | |\r\n| geographicNotes | InPlaceAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityId | InPlaceAsset->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | InPlaceAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | InPlaceAsset->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | InPlaceAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | InPlaceAsset->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | InPlaceAsset->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | InPlaceAsset->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAsset->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAsset->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAsset->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAsset->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAsset->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAsset->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAsset->ModifiedOn | string | date-time |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAsset->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAsset->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAsset->PermissionTree_Description | string | |\r\n| treePathId | InPlaceAsset->TreePathId | integer | int64 |\r\n| treePathItems | InPlaceAsset->TreePathItems | array | array |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | InPlaceAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | InPlaceAsset->AcquisitionStatus_Description | string | |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | InPlaceAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | InPlaceAsset->AcquisitionType_Description | string | |\r\n| alternativeDescription | InPlaceAsset->AlternativeDescription | string | |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | InPlaceAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | InPlaceAsset->AssetImportance_Description | string | |\r\n| assetTypeId | InPlaceAsset->AssetType_Id | integer | int64 |\r\n| assetTypeCode | InPlaceAsset->AssetType_Code | string | |\r\n| assetTypeDescription | InPlaceAsset->AssetType_Description | string | |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | InPlaceAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | InPlaceAsset->CommissioningWorkOrder_Description | string | |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| description | InPlaceAsset->Description | string | |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| inheritedFromId | InPlaceAsset->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | InPlaceAsset->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isPermitRequired | InPlaceAsset->IsPermitRequired | boolean | |\r\n| isRunning | InPlaceAsset->IsRunning | boolean | |\r\n| notes | InPlaceAsset->Notes | string | |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| recordType | InPlaceAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | InPlaceAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | InPlaceAsset->ReplacementAsset_Description | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | InPlaceAsset->Supplier_Code | string | |\r\n| supplierDescription | InPlaceAsset->Supplier_Description | string | |\r\n| taskRollUpPointId | InPlaceAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | InPlaceAsset->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | InPlaceAsset->TaskRollUpPoint_Description | string | |\r\n| warranty | InPlaceAsset->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "BatchGetInPlaceAsset", "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 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 collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Batch": { "post": { "tags": [ "In-Place Asset" ], "summary": "Create a new collection of In-Place Asset resources.", "description": "### Request Body\r\n#### 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 | InPlaceAsset->PermissionTree_Id | integer | int64 |\r\n| siteId | InPlaceAsset->Site_Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| alternativeDescription | InPlaceAsset->AlternativeDescription | string | |\r\n| parentAssetId | InPlaceAsset->ParentAsset_Id | integer | int64 |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| assetTypeId | InPlaceAsset->AssetType_Id | integer | int64 |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| isPermitRequired | InPlaceAsset->IsPermitRequired | boolean | |\r\n| isRunning | InPlaceAsset->IsRunning | boolean | |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| notes | InPlaceAsset->Notes | string | |\r\n| geographicLocation | InPlaceAsset->GeographicLocation | object | |\r\n| geographicStartPosition | InPlaceAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | InPlaceAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | InPlaceAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | InPlaceAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | InPlaceAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | InPlaceAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | InPlaceAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | 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| 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| parentAssetId | Required | True | |\r\n| parentAssetId | Nullable | False | |\r\n| parentAssetId | Min Value | > 1| |\r\n| isMsi | Nullable | False | |\r\n| isForScheduledWorkOnly | Required | True | |\r\n| isForScheduledWorkOnly | Nullable | False | |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| calendarId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAsset", "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/BatchCreateInPlaceAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - In-Place Asset 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" ], "summary": "Update a collection of existing In-Place Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| alternativeDescription | InPlaceAsset->AlternativeDescription | string | |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| isPermitRequired | InPlaceAsset->IsPermitRequired | boolean | |\r\n| isRunning | InPlaceAsset->IsRunning | boolean | |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| notes | InPlaceAsset->Notes | string | |\r\n| geographicLocation | InPlaceAsset->GeographicLocation | object | |\r\n| geographicStartPosition | InPlaceAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | InPlaceAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | InPlaceAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | InPlaceAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | InPlaceAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | InPlaceAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | InPlaceAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| 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 | InPlaceAsset->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 | InPlaceAsset->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| isMsi | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| calendarId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateInPlaceAsset", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateInPlaceAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset 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": [ "In-Place Asset" ], "summary": "Delete a collection of existing In-Place Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| version | InPlaceAsset->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": "BatchDeleteInPlaceAsset", "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/BatchDeleteInPlaceAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset 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/InPlaceAssets/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset" ], "summary": "Accept the Development Status for an existing In-Place Asset resource.", "description": "", "operationId": "AcceptInPlaceAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Batch/{ids}/Sync": { "post": { "tags": [ "In-Place Asset" ], "summary": "Synchronise the collection of existing In-Place Asset resource id's.", "description": "", "operationId": "BatchSyncInPlaceAsset", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Active": { "patch": { "tags": [ "In-Place Asset" ], "summary": "Change the IsActive status for an existing In-Place Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| isActive | InPlaceAsset->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": "ChangeInPlaceAssetIsActive", "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 Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/InPlaceAssets/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset" ], "summary": "Change the PermissionTree for an existing In-Place Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAsset->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": "ChangeInPlaceAssetPermissionTree", "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 Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/InPlaceAssets/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset" ], "summary": "Reject the Development Status for an existing In-Place Asset resource.", "description": "", "operationId": "RejectInPlaceAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Sync/Resubscribe": { "post": { "tags": [ "In-Place Asset" ], "summary": "Accept the Development Status for an existing In-Place Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "ResubscribeInPlaceAssetDevelopmentStatus", "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/ResubscribeInPlaceAssetDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Sync": { "post": { "tags": [ "In-Place Asset" ], "summary": "Synchronise the existing In-Place Asset resource.", "description": "", "operationId": "SyncInPlaceAsset", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Sync/Unsubscribe": { "post": { "tags": [ "In-Place Asset" ], "summary": "Accept the Development Status for an existing In-Place Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "UnsubscribeInPlaceAssetDevelopmentStatus", "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/UnsubscribeInPlaceAssetDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Batch/Active": { "patch": { "tags": [ "In-Place Asset" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| isActive | InPlaceAsset->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": "BatchChangeInPlaceAssetIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/InPlaceAssets/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAsset->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": "BatchChangeInPlaceAssetPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/InPlaceAssets/MatchBatch": { "patch": { "tags": [ "In-Place Asset" ], "summary": "Update a collection of existing In-Place Asset 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 | InPlaceAsset->Id | integer | int64 |\r\n| version | InPlaceAsset->Version | integer | int32 |\r\n| description | InPlaceAsset->Description | string | |\r\n| alternativeDescription | InPlaceAsset->AlternativeDescription | string | |\r\n| qRCode | InPlaceAsset->QRCode | string | |\r\n| rFId | InPlaceAsset->RFId | string | |\r\n| serialNumber | InPlaceAsset->SerialNumber | string | |\r\n| sequenceNumber | InPlaceAsset->SequenceNumber | integer | int32 |\r\n| barcode | InPlaceAsset->Barcode | string | |\r\n| isPermitRequired | InPlaceAsset->IsPermitRequired | boolean | |\r\n| isRunning | InPlaceAsset->IsRunning | boolean | |\r\n| isMsi | InPlaceAsset->IsMsi | boolean | |\r\n| isForScheduledWorkOnly | InPlaceAsset->IsForScheduledWorkOnly | boolean | |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | InPlaceAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | InPlaceAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| calendarId | InPlaceAsset->Calendar_Id | integer | int64 |\r\n| commissioningWorkOrderId | InPlaceAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | InPlaceAsset->PurchaseAmount | number | decimal |\r\n| currentValue | InPlaceAsset->CurrentValue | number | decimal |\r\n| supplierId | InPlaceAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | InPlaceAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | InPlaceAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | InPlaceAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | InPlaceAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | InPlaceAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | InPlaceAsset->InsuredValue | number | decimal |\r\n| commissionedOn | InPlaceAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | InPlaceAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | InPlaceAsset->DateOfCurrentValue | string | date |\r\n| notes | InPlaceAsset->Notes | string | |\r\n\r\n#### Business Rules\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| description | Nullable | False | |\r\n| description | Read-only | True | InPlaceAsset->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| isMsi | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| calendarId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | InPlaceAsset->IsMsi eq true |\r\n\r\n", "operationId": "MatchUpdateInPlaceAsset", "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/MatchUpdateInPlaceAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset 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/InPlaceAssets/Attributes/{id}": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Get a collection of In-Place Asset Attribute resources for the In-Place Asset.", "description": "### Response Body\r\n#### 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 | InPlaceAssetAttribute->InheritedFrom_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetAttribute->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetAttribute->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetAttribute->InPlaceAsset_Description | string | |\r\n| developmentStatus | InPlaceAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | InPlaceAssetAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAssetAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAssetAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAssetAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | InPlaceAssetAttribute->IsHistorical | boolean | |\r\n| unsynchronised | InPlaceAssetAttribute->Unsynchronised | boolean | |\r\n| isInherited | InPlaceAssetAttribute->IsInherited | boolean | |\r\n| createdByUserId | InPlaceAssetAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetAttribute->CreatedOn | string | date-time |\r\n| isActive | InPlaceAssetAttribute->IsActive | boolean | |\r\n| modifiedByUserId | InPlaceAssetAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | InPlaceAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetAttribute->PermissionTree_Description | string | |\r\n| version | InPlaceAssetAttribute->Version | integer | int32 |\r\n| id | InPlaceAssetAttribute->Id | integer | int64 |\r\n| attributeId | InPlaceAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | InPlaceAssetAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | InPlaceAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | InPlaceAssetAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n", "operationId": "GetInPlaceAssetAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Attribute", "schema": { "$ref": "#/definitions/GetInPlaceAssetAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Attribute" ], "summary": "Update an existing In-Place Asset 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 | InPlaceAssetAttribute->Version | integer | int32 |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateInPlaceAssetAttribute", "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 Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "In-Place Asset Attribute" ], "summary": "Delete an existing In-Place Asset 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 | InPlaceAssetAttribute->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": "DeleteInPlaceAssetAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteInPlaceAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{inPlaceAssetId}/Attributes": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Get a collection of In-Place Asset Attribute resources for the In-Place Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetAttribute->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | InPlaceAssetAttribute->IsInherited | boolean | |\r\n| attributeId | InPlaceAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetAttribute->Attribute_Description | string | |\r\n| attributeDataType | InPlaceAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetAttribute->PredefinedValue_Value | object | composite |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n| createdOn | InPlaceAssetAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | InPlaceAssetAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetInPlaceAssetAttributeCollectionForInPlaceAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "inPlaceAssetId", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Attribute collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetAttributeCollectionForInPlaceAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAssetAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetAttribute->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | InPlaceAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | InPlaceAssetAttribute->IsInherited | boolean | |\r\n| inPlaceAssetCode | InPlaceAssetAttribute->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetAttribute->InPlaceAsset_Description | string | |\r\n| attributeId | InPlaceAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetAttribute->Attribute_Description | string | |\r\n| attributeDataType | InPlaceAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetAttribute->PredefinedValue_Value | object | composite |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n| createdOn | InPlaceAssetAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | InPlaceAssetAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetInPlaceAssetAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Attribute collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Attribute" ], "summary": "Create a new In-Place Asset 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| inPlaceAssetId | InPlaceAssetAttribute->InPlaceAsset_Id | integer | int64 |\r\n| attributeId | InPlaceAssetAttribute->Attribute_Id | integer | int64 |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | 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": "CreateInPlaceAssetAttribute", "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/CreateInPlaceAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Lookups/LookupInPlaceAssetAttributeAllowedValue": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Lookup the Attribute Allowed Value for the In-Place Asset 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": "LookupInPlaceAssetAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Lookups/LookupInPlaceAssetAttribute": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Lookup the Attribute for the In-Place Asset 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": "LookupInPlaceAssetAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Lookups/LookupInPlaceAssetAttributeChangePermissionTree": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Lookup the permission set for changing the In-Place Asset 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": "LookupInPlaceAssetAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Lookups/LookupInPlaceAssetAttributeInPlaceAsset": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Lookup the In-Place Asset Attribute for the In-Place Asset 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 | InPlaceAsset->Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n", "operationId": "LookupInPlaceAssetAttributeInPlaceAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/InPlaceAssetAttributeRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Lookups/LookupInPlaceAssetAttributeInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Lookup the permission set for creating the In-Place Asset 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": "LookupInPlaceAssetAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Attribute" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAssetAttribute->InheritedFrom_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetAttribute->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetAttribute->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetAttribute->InPlaceAsset_Description | string | |\r\n| developmentStatus | InPlaceAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | InPlaceAssetAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAssetAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAssetAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAssetAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | InPlaceAssetAttribute->IsHistorical | boolean | |\r\n| unsynchronised | InPlaceAssetAttribute->Unsynchronised | boolean | |\r\n| isInherited | InPlaceAssetAttribute->IsInherited | boolean | |\r\n| createdByUserId | InPlaceAssetAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetAttribute->CreatedOn | string | date-time |\r\n| isActive | InPlaceAssetAttribute->IsActive | boolean | |\r\n| modifiedByUserId | InPlaceAssetAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | InPlaceAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetAttribute->PermissionTree_Description | string | |\r\n| version | InPlaceAssetAttribute->Version | integer | int32 |\r\n| id | InPlaceAssetAttribute->Id | integer | int64 |\r\n| attributeId | InPlaceAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | InPlaceAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | InPlaceAssetAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | InPlaceAssetAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | InPlaceAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | InPlaceAssetAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | InPlaceAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | InPlaceAssetAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n", "operationId": "BatchGetInPlaceAssetAttribute", "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 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 Attribute collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Batch": { "post": { "tags": [ "In-Place Asset Attribute" ], "summary": "Create a new collection of In-Place Asset 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| inPlaceAssetId | InPlaceAssetAttribute->InPlaceAsset_Id | integer | int64 |\r\n| attributeId | InPlaceAssetAttribute->Attribute_Id | integer | int64 |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | 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": "BatchCreateInPlaceAssetAttribute", "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/BatchCreateInPlaceAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - In-Place Asset 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 Attribute" ], "summary": "Update a collection of existing In-Place Asset 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 | InPlaceAssetAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetAttribute->Version | integer | int32 |\r\n| value | InPlaceAssetAttribute->Value | object | composite |\r\n| predefinedValueId | InPlaceAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdateInPlaceAssetAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateInPlaceAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "In-Place Asset Attribute" ], "summary": "Delete a collection of existing In-Place Asset 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 | InPlaceAssetAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetAttribute->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": "BatchDeleteInPlaceAssetAttribute", "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/BatchDeleteInPlaceAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Attribute" ], "summary": "Accept the Development Status for an existing In-Place Asset Attribute resource.", "description": "", "operationId": "AcceptInPlaceAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Attribute" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Attribute resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Attribute" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Attribute resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/{id}/Active": { "patch": { "tags": [ "In-Place Asset Attribute" ], "summary": "Change the IsActive status for an existing In-Place Asset 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 | InPlaceAssetAttribute->Version | integer | int32 |\r\n| isActive | InPlaceAssetAttribute->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": "ChangeInPlaceAssetAttributeIsActive", "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 Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetAttributeIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Attribute" ], "summary": "Change the PermissionTree for an existing In-Place Asset 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 | InPlaceAssetAttribute->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetAttribute->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": "ChangeInPlaceAssetAttributePermissionTree", "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 Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetAttributePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Attribute" ], "summary": "Reject the Development Status for an existing In-Place Asset Attribute resource.", "description": "", "operationId": "RejectInPlaceAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Attributes/Batch/Active": { "patch": { "tags": [ "In-Place Asset Attribute" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset 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 | InPlaceAssetAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetAttribute->Version | integer | int32 |\r\n| isActive | InPlaceAssetAttribute->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": "BatchChangeInPlaceAssetAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetAttributeIsActiveResourceActionRequest" } }, { "$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/InPlaceAssets/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset Attribute" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset 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 | InPlaceAssetAttribute->Id | integer | int64 |\r\n| version | InPlaceAssetAttribute->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetAttribute->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": "BatchChangeInPlaceAssetAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetAttributePermissionTreeResourceActionRequest" } }, { "$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/InPlaceAssets/Consumption/{id}": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Get a In-Place Asset Consumption 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| inPlaceAssetId | InPlaceAssetConsumption->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetConsumption->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetConsumption->InPlaceAsset_Description | string | |\r\n| isActive | InPlaceAssetConsumption->IsActive | boolean | |\r\n| createdByUserId | InPlaceAssetConsumption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetConsumption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetConsumption->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetConsumption->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetConsumption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetConsumption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetConsumption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetConsumption->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetConsumption->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetConsumption->PermissionTree_Description | string | |\r\n| id | InPlaceAssetConsumption->Id | integer | int64 |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | InPlaceAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | InPlaceAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | InPlaceAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | InPlaceAssetConsumption->CostElement_Description | string | |\r\n| currencyId | InPlaceAssetConsumption->Currency_Id | integer | int64 |\r\n| currencyCode | InPlaceAssetConsumption->Currency_Code | string | |\r\n| currencyDescription | InPlaceAssetConsumption->Currency_Description | string | |\r\n| currencyRateId | InPlaceAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateUserSuppliedConversionRate | InPlaceAssetConsumption->CurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| currencyRateAppliedConversionRate | InPlaceAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | InPlaceAssetConsumption->CurrencyRateValue | number | decimal |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | InPlaceAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | InPlaceAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAssetConsumption->GeneralLedger_Description | string | |\r\n| locationId | InPlaceAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAssetConsumption->Location_Code | string | |\r\n| locationDescription | InPlaceAssetConsumption->Location_Description | string | |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetConsumption->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetConsumption->Meter_Description | string | |\r\n| meterUnitOfMeasurementId | InPlaceAssetConsumption->Meter_UnitOfMeasurement_Id | integer | int64 |\r\n| meterUnitOfMeasurementCode | InPlaceAssetConsumption->Meter_UnitOfMeasurement_Code | string | |\r\n| meterUnitOfMeasurementDescription | InPlaceAssetConsumption->Meter_UnitOfMeasurement_Description | string | |\r\n| meterReadingId | InPlaceAssetConsumption->MeterReading_Id | integer | int64 |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| notes | InPlaceAssetConsumption->Notes | string | |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | InPlaceAssetConsumption->Resource_Description | string | |\r\n| siteId | InPlaceAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAssetConsumption->Site_Code | string | |\r\n| siteDescription | InPlaceAssetConsumption->Site_Description | string | |\r\n| siteCurrencyId | InPlaceAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | InPlaceAssetConsumption->SiteCurrency_Code | string | |\r\n| siteCurrencyDescription | InPlaceAssetConsumption->SiteCurrency_Description | string | |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | InPlaceAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | InPlaceAssetConsumption->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | InPlaceAssetConsumption->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | InPlaceAssetConsumption->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | InPlaceAssetConsumption->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | InPlaceAssetConsumption->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | InPlaceAssetConsumption->StockItem_Warehouse_Description | string | |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | InPlaceAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | InPlaceAssetConsumption->Supplier_Description | string | |\r\n| totalCost | InPlaceAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | InPlaceAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | InPlaceAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | InPlaceAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n", "operationId": "GetInPlaceAssetConsumption", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Consumption Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Consumption", "schema": { "$ref": "#/definitions/GetInPlaceAssetConsumptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Consumption" ], "summary": "Update an existing In-Place Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | InPlaceAssetConsumption->Currency_Id | integer | int64 |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | InPlaceAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | Nullable | False | |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | >= 0| |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "UpdateInPlaceAssetConsumption", "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 Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Consumption was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-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": [ "In-Place Asset Consumption" ], "summary": "Delete an existing In-Place Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetConsumption->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": "DeleteInPlaceAssetConsumption", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteInPlaceAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Consumption 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/InPlaceAssets/Consumption/{assetConsumptionId}/Costing": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Get a collection of Costing resources for the In-Place Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Costing->Id | integer | int64 |\r\n| description | Costing->Description | string | |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n", "operationId": "GetCostingForInPlaceAssetConsumptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "assetConsumptionId", "in": "path", "required": true, "description": "Asset Consumption 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 Consumption collection", "schema": { "$ref": "#/definitions/GetCostingCollectionForInPlaceAssetConsumptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Get a collection of In-Place Asset Consumption 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 | InPlaceAssetConsumption->Id | integer | int64 |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | InPlaceAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | InPlaceAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | InPlaceAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | InPlaceAssetConsumption->CostElement_Description | string | |\r\n| currencyRateId | InPlaceAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | InPlaceAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | InPlaceAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | InPlaceAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAssetConsumption->GeneralLedger_Description | string | |\r\n| inPlaceAssetId | InPlaceAssetConsumption->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetConsumption->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetConsumption->InPlaceAsset_Description | string | |\r\n| inPlaceAssetRecordType | InPlaceAssetConsumption->InPlaceAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| locationId | InPlaceAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAssetConsumption->Location_Code | string | |\r\n| locationDescription | InPlaceAssetConsumption->Location_Description | string | |\r\n| siteId | InPlaceAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAssetConsumption->Site_Code | string | |\r\n| siteDescription | InPlaceAssetConsumption->Site_Description | string | |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetConsumption->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetConsumption->Meter_Description | string | |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | InPlaceAssetConsumption->Resource_Description | string | |\r\n| siteCurrencyId | InPlaceAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | InPlaceAssetConsumption->SiteCurrency_Code | string | |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | InPlaceAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | InPlaceAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | InPlaceAssetConsumption->Supplier_Description | string | |\r\n| totalCost | InPlaceAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | InPlaceAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | InPlaceAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | InPlaceAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n", "operationId": "GetInPlaceAssetConsumptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Consumption collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetConsumptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Consumption" ], "summary": "Create a new In-Place Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetId | InPlaceAssetConsumption->InPlaceAsset_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | InPlaceAssetConsumption->Currency_Id | integer | int64 |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | InPlaceAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| consumableId | Required | True | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | System Generated | true | If no value specified |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| unitPrice | System Generated | true | If no value specified |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | >= 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAssetConsumption", "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/CreateInPlaceAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Consumption": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Get a collection of InPlaceAssetConsumption resources for the InPlace Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetConsumption->Id | integer | int64 |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| inPlaceAssetId | InPlaceAssetConsumption->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetConsumption->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetConsumption->InPlaceAsset_Description | string | |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | InPlaceAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | InPlaceAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | InPlaceAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | InPlaceAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAssetConsumption->GeneralLedger_Description | string | |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | InPlaceAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | InPlaceAssetConsumption->CostElement_Description | string | |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | InPlaceAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | InPlaceAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | InPlaceAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| locationId | InPlaceAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAssetConsumption->Location_Code | string | |\r\n| locationDescription | InPlaceAssetConsumption->Location_Description | string | |\r\n| siteId | InPlaceAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAssetConsumption->Site_Code | string | |\r\n| siteDescription | InPlaceAssetConsumption->Site_Description | string | |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetConsumption->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetConsumption->Meter_Description | string | |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | InPlaceAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | InPlaceAssetConsumption->Supplier_Description | string | |\r\n| siteCurrencyId | InPlaceAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | InPlaceAssetConsumption->SiteCurrency_Code | string | |\r\n| currencyRateId | InPlaceAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | InPlaceAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n| totalCost | InPlaceAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | InPlaceAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | InPlaceAssetConsumption->Resource_Description | string | |\r\n", "operationId": "GetInPlaceAssetConsumptionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Consumption collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetConsumptionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionChangePermissionTree": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup the permission set for changing the In-Place Asset Consumption.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetConsumptionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetConsumptionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionConsumable": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup the Consumable for the In-Place Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Consumable->Id | integer | int64 |\r\n| code | Consumable->Code | string | |\r\n| description | Consumable->Description | string | |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Consumable->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Consumable->UnitOfMeasurement_Description | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| currencyCode | Consumable->Currency_Code | string | |\r\n| currencyDescription | Consumable->Currency_Description | string | |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\r\n", "operationId": "LookupInPlaceAssetConsumptionConsumable", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Consumable collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionConsumableLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionCostCentre": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Cost Centre for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionCostElement": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Cost Element for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetConsumptionCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetConsumptionCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionCurrency": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Currency for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionFinancialYearPeriod": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Financial Year Period for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionFinancialYearPeriod", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year Period collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionGeneralLedger": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup General Ledger for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionInPlaceAsset": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup the In-Place Asset for the In-Place Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| siteId | InPlaceAsset->Site_Id | integer | int64 |\r\n| siteFinancialYearPeriodId | InPlaceAsset->Site_FinancialYearPeriod_Id | integer | int64 |\r\n| siteFinancialYearPeriodCode | InPlaceAsset->Site_FinancialYearPeriod_Code | string | |\r\n| siteFinancialYearPeriodDescription | InPlaceAsset->Site_FinancialYearPeriod_Description | string | |\r\n| siteCurrencyId | InPlaceAsset->Site_Currency_Id | integer | int64 |\r\n| siteCurrencyCode | InPlaceAsset->Site_Currency_Code | string | |\r\n| siteCurrencyDescription | InPlaceAsset->Site_Currency_Description | string | |\r\n| siteCode | InPlaceAsset->Site_Code | string | |\r\n| siteDescription | InPlaceAsset->Site_Description | string | |\r\n| costCentreId | InPlaceAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAsset->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAsset->CostCentre_Description | string | |\r\n| generalLedgerId | InPlaceAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAsset->GeneralLedger_Description | string | |\r\n| locationId | InPlaceAsset->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAsset->Location_Code | string | |\r\n| locationDescription | InPlaceAsset->Location_Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionInPlaceAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionInPlaceAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup the permission set for creating the In-Place Asset Consumption.", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetConsumptionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetConsumptionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionMeter": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Meter for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Meter->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Meter->UnitOfMeasurement_Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionResource": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Resource for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\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": "LookupInPlaceAssetConsumptionResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetConsumptionResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionStockItem": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Stock Item for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionStockItem", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Stock Item collection", "schema": { "$ref": "#/definitions/InPlaceAssetConsumptionStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionSupplier": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Supplier for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n| siteCurrencyId | Supplier->Site_Currency_Id | integer | int64 |\r\n| siteCurrencyCode | Supplier->Site_Currency_Code | string | |\r\n| siteCurrencyDescription | Supplier->Site_Currency_Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetConsumptionSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Lookups/LookupInPlaceAssetConsumptionUnitOfMeasurement": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Lookup Unit Of Measurement for the In-Place Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupInPlaceAssetConsumptionUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetConsumptionUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Consumption" ], "summary": "Get a collection of In-Place Asset Consumption 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| inPlaceAssetId | InPlaceAssetConsumption->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetConsumption->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetConsumption->InPlaceAsset_Description | string | |\r\n| isActive | InPlaceAssetConsumption->IsActive | boolean | |\r\n| createdByUserId | InPlaceAssetConsumption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetConsumption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetConsumption->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetConsumption->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetConsumption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetConsumption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetConsumption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetConsumption->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetConsumption->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetConsumption->PermissionTree_Description | string | |\r\n| id | InPlaceAssetConsumption->Id | integer | int64 |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | InPlaceAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | InPlaceAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | InPlaceAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | InPlaceAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | InPlaceAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | InPlaceAssetConsumption->CostElement_Description | string | |\r\n| currencyId | InPlaceAssetConsumption->Currency_Id | integer | int64 |\r\n| currencyCode | InPlaceAssetConsumption->Currency_Code | string | |\r\n| currencyDescription | InPlaceAssetConsumption->Currency_Description | string | |\r\n| currencyRateId | InPlaceAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateUserSuppliedConversionRate | InPlaceAssetConsumption->CurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| currencyRateAppliedConversionRate | InPlaceAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | InPlaceAssetConsumption->CurrencyRateValue | number | decimal |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | InPlaceAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | InPlaceAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | InPlaceAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | InPlaceAssetConsumption->GeneralLedger_Description | string | |\r\n| locationId | InPlaceAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | InPlaceAssetConsumption->Location_Code | string | |\r\n| locationDescription | InPlaceAssetConsumption->Location_Description | string | |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetConsumption->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetConsumption->Meter_Description | string | |\r\n| meterUnitOfMeasurementId | InPlaceAssetConsumption->Meter_UnitOfMeasurement_Id | integer | int64 |\r\n| meterUnitOfMeasurementCode | InPlaceAssetConsumption->Meter_UnitOfMeasurement_Code | string | |\r\n| meterUnitOfMeasurementDescription | InPlaceAssetConsumption->Meter_UnitOfMeasurement_Description | string | |\r\n| meterReadingId | InPlaceAssetConsumption->MeterReading_Id | integer | int64 |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| notes | InPlaceAssetConsumption->Notes | string | |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | InPlaceAssetConsumption->Resource_Description | string | |\r\n| siteId | InPlaceAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAssetConsumption->Site_Code | string | |\r\n| siteDescription | InPlaceAssetConsumption->Site_Description | string | |\r\n| siteCurrencyId | InPlaceAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | InPlaceAssetConsumption->SiteCurrency_Code | string | |\r\n| siteCurrencyDescription | InPlaceAssetConsumption->SiteCurrency_Description | string | |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | InPlaceAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | InPlaceAssetConsumption->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | InPlaceAssetConsumption->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | InPlaceAssetConsumption->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | InPlaceAssetConsumption->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | InPlaceAssetConsumption->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | InPlaceAssetConsumption->StockItem_Warehouse_Description | string | |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | InPlaceAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | InPlaceAssetConsumption->Supplier_Description | string | |\r\n| totalCost | InPlaceAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | InPlaceAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | InPlaceAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | InPlaceAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n", "operationId": "BatchGetInPlaceAssetConsumption", "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 Consumption 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 Consumption collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetConsumptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Batch": { "post": { "tags": [ "In-Place Asset Consumption" ], "summary": "Create a new collection of In-Place Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| inPlaceAssetId | InPlaceAssetConsumption->InPlaceAsset_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | InPlaceAssetConsumption->Currency_Id | integer | int64 |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | InPlaceAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| consumableId | Required | True | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | System Generated | true | If no value specified |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| unitPrice | System Generated | true | If no value specified |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | >= 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetConsumption", "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/BatchCreateInPlaceAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - In-Place Asset Consumption 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 Consumption" ], "summary": "Update a collection of existing In-Place Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetConsumption->Id | integer | int64 |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| resourceId | InPlaceAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | InPlaceAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | InPlaceAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | InPlaceAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | InPlaceAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| quantity | InPlaceAssetConsumption->Quantity | number | decimal |\r\n| meterId | InPlaceAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | InPlaceAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | InPlaceAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | InPlaceAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | InPlaceAssetConsumption->Currency_Id | integer | int64 |\r\n| unitPrice | InPlaceAssetConsumption->UnitPrice | number | decimal |\r\n| costCentreId | InPlaceAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | InPlaceAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | InPlaceAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | InPlaceAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | InPlaceAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | InPlaceAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | InPlaceAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | Nullable | False | |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | >= 0| |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetConsumption", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateInPlaceAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Consumption 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": [ "In-Place Asset Consumption" ], "summary": "Delete a collection of existing In-Place Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetConsumption->Id | integer | int64 |\r\n| version | InPlaceAssetConsumption->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": "BatchDeleteInPlaceAssetConsumption", "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/BatchDeleteInPlaceAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Consumption 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/InPlaceAssets/Consumption/{id}/Active": { "patch": { "tags": [ "In-Place Asset Consumption" ], "summary": "Change the IsActive status for an existing In-Place Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| isActive | InPlaceAssetConsumption->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": "ChangeInPlaceAssetConsumptionIsActive", "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 Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetConsumptionIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Consumption" ], "summary": "Change the PermissionTree for an existing In-Place Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetConsumption->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": "ChangeInPlaceAssetConsumptionPermissionTree", "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 Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetConsumptionPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/ValidateMeterAdr": { "post": { "tags": [ "In-Place Asset Consumption" ], "summary": "Validate whether the Meter Reading will cause the Meter's AverageDailyRate to exceed the allowed configured values.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| meterId | ValidateMeterAdrEntity->Meter_Id | integer | int64 |\r\n| meterReadingId | ValidateMeterAdrEntity->MeterReading_Id | integer | int64 |\r\n| readingValue | ValidateMeterAdrEntity->ReadingValue | number | decimal |\r\n| readingOn | ValidateMeterAdrEntity->ReadingOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "ValidateInPlaceAssetConsumptionMeterAdr", "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/ValidateAssetConsumptionMeterAdrResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Consumption/Batch/Active": { "patch": { "tags": [ "In-Place Asset Consumption" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetConsumption->Id | integer | int64 |\r\n| version | InPlaceAssetConsumption->Version | integer | int32 |\r\n| isActive | InPlaceAssetConsumption->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": "BatchChangeInPlaceAssetConsumptionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetConsumptionIsActiveResourceActionRequest" } }, { "$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/InPlaceAssets/Meters/{id}": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Get a In-Place Asset Meter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | InPlaceAssetMeter->IsActive | boolean | |\r\n| createdByUserId | InPlaceAssetMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetMeter->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetMeter->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetMeter->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetMeter->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetMeter->PermissionTree_Description | string | |\r\n| id | InPlaceAssetMeter->Id | integer | int64 |\r\n| assetMeterType | InPlaceAssetMeter->AssetMeterType | string (Allowed values: [InPlaceAssetMeter]) | enum |\r\n| inPlaceAssetId | InPlaceAssetMeter->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetMeter->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetMeter->InPlaceAsset_Description | string | |\r\n| isMainMeter | InPlaceAssetMeter->IsMainMeter | boolean | |\r\n| meterId | InPlaceAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetMeter->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetMeter->Meter_Description | string | |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n| sequenceNumber | InPlaceAssetMeter->SequenceNumber | integer | int32 |\r\n", "operationId": "GetInPlaceAssetMeter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Meter", "schema": { "$ref": "#/definitions/GetInPlaceAssetMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Meter" ], "summary": "Update an existing In-Place Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetMeter->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetMeter->SequenceNumber | integer | int32 |\r\n| isMainMeter | InPlaceAssetMeter->IsMainMeter | boolean | |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "UpdateInPlaceAssetMeter", "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 Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Meter was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "In-Place Asset Meter" ], "summary": "Delete an existing In-Place Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetMeter->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": "DeleteInPlaceAssetMeter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteInPlaceAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Meter was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Get a collection of In-Place Asset Meter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetMeter->Version | integer | int32 |\r\n| id | InPlaceAssetMeter->Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetMeter->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetMeter->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetMeter->InPlaceAsset_Description | string | |\r\n| meterId | InPlaceAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetMeter->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetMeter->Meter_Description | string | |\r\n| isActive | InPlaceAssetMeter->IsActive | boolean | |\r\n| isMainMeter | InPlaceAssetMeter->IsMainMeter | boolean | |\r\n| sequenceNumber | InPlaceAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n", "operationId": "GetInPlaceAssetMeterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Meter" ], "summary": "Create a new In-Place Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | InPlaceAssetMeter->PermissionTree_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetMeter->InPlaceAsset_Id | integer | int64 |\r\n| meterId | InPlaceAssetMeter->Meter_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n\r\n#### Business 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| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | Nullable | False | |\r\n| inPlaceAssetId | Min Value | >= 0| |\r\n| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAssetMeter", "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/CreateInPlaceAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Meters": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Get a collection of InPlace Asset Meter resources for the Asset.", "description": "### Response Body\r\n#### 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 | InPlaceAssetMeter->Version | integer | int32 |\r\n| id | InPlaceAssetMeter->Id | integer | int64 |\r\n| meterId | InPlaceAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetMeter->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetMeter->Meter_Description | string | |\r\n| isActive | InPlaceAssetMeter->IsActive | boolean | |\r\n| isMainMeter | InPlaceAssetMeter->IsMainMeter | boolean | |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n", "operationId": "GetInPlaceAssetMeterForInPlaceAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Meter collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetMeterForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/Lookups/LookupInPlaceAssetMeterAsset": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Lookup the In-Place Asset for the In-Place Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAsset->Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n| siteId | InPlaceAsset->Site_Id | integer | int64 |\r\n| siteCode | InPlaceAsset->Site_Code | string | |\r\n| siteDescription | InPlaceAsset->Site_Description | string | |\r\n", "operationId": "LookupInPlaceAssetMeterAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/InPlaceAssetMeterAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/Lookups/LookupInPlaceAssetMeterChangePermissionTree": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Lookup the permission set for changing the In-Place Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupInPlaceAssetMeterChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetMeterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/Lookups/LookupInPlaceAssetMeterInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Lookup the permission set for creating the In-Place Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupInPlaceAssetMeterInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetMeterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/Lookups/LookupInPlaceAssetMeterMeter": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Lookup the Meter for the In-Place Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| siteCode | Meter->Site_Code | string | |\r\n| siteDescription | Meter->Site_Description | string | |\r\n", "operationId": "LookupInPlaceAssetMeterMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter collection", "schema": { "$ref": "#/definitions/InPlaceAssetMeterMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Meter" ], "summary": "Get a collection of In-Place Asset Meter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | InPlaceAssetMeter->IsActive | boolean | |\r\n| createdByUserId | InPlaceAssetMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetMeter->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetMeter->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetMeter->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetMeter->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetMeter->PermissionTree_Description | string | |\r\n| id | InPlaceAssetMeter->Id | integer | int64 |\r\n| assetMeterType | InPlaceAssetMeter->AssetMeterType | string (Allowed values: [InPlaceAssetMeter]) | enum |\r\n| inPlaceAssetId | InPlaceAssetMeter->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetMeter->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetMeter->InPlaceAsset_Description | string | |\r\n| isMainMeter | InPlaceAssetMeter->IsMainMeter | boolean | |\r\n| meterId | InPlaceAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | InPlaceAssetMeter->Meter_Code | string | |\r\n| meterDescription | InPlaceAssetMeter->Meter_Description | string | |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n| sequenceNumber | InPlaceAssetMeter->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetInPlaceAssetMeter", "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 Meter id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Meter collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetMeterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/Batch": { "post": { "tags": [ "In-Place Asset Meter" ], "summary": "Create a new collection of In-Place Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | InPlaceAssetMeter->PermissionTree_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetMeter->InPlaceAsset_Id | integer | int64 |\r\n| meterId | InPlaceAssetMeter->Meter_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n\r\n#### Business 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| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | Nullable | False | |\r\n| inPlaceAssetId | Min Value | >= 0| |\r\n| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetMeter", "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/BatchCreateInPlaceAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - In-Place Asset Meter batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Meter" ], "summary": "Update a collection of existing In-Place Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetMeter->Id | integer | int64 |\r\n| version | InPlaceAssetMeter->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetMeter->SequenceNumber | integer | int32 |\r\n| isMainMeter | InPlaceAssetMeter->IsMainMeter | boolean | |\r\n| notes | InPlaceAssetMeter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetMeter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateInPlaceAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Meter batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "In-Place Asset Meter" ], "summary": "Delete a collection of existing In-Place Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetMeter->Id | integer | int64 |\r\n| version | InPlaceAssetMeter->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": "BatchDeleteInPlaceAssetMeter", "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/BatchDeleteInPlaceAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Meter batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/{id}/Active": { "patch": { "tags": [ "In-Place Asset Meter" ], "summary": "Change the IsActive status for an existing In-Place Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | InPlaceAssetMeter->Version | integer | int32 |\r\n| isActive | InPlaceAssetMeter->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": "ChangeInPlaceAssetMeterIsActive", "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 Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetMeterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/{id}/SetMainMeterStatus": { "patch": { "tags": [ "In-Place Asset Meter" ], "summary": "Set the Main Meter status.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetInPlaceAssetMainMeterStatus->Version | integer | int32 |\r\n| isMainMeter | SetInPlaceAssetMainMeterStatus->IsMainMeter | 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| isMainMeter | Required | True | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "SetInPlaceAssetMainMeterStatus", "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 Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/SetMainInPlaceAssetMeterStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Meters/Batch/Active": { "patch": { "tags": [ "In-Place Asset Meter" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetMeter->Id | integer | int64 |\r\n| version | InPlaceAssetMeter->Version | integer | int32 |\r\n| isActive | InPlaceAssetMeter->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": "BatchChangeInPlaceAssetMeterIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetMeterIsActiveResourceActionRequest" } }, { "$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/InPlaceAssets/Responsibilities/{id}": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Get a In-Place Asset 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 | InPlaceAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| isActive | InPlaceAssetResponsibility->IsActive | boolean | |\r\n| isHistorical | InPlaceAssetResponsibility->IsHistorical | boolean | |\r\n| isInherited | InPlaceAssetResponsibility->IsInherited | boolean | |\r\n| isProposed | InPlaceAssetResponsibility->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAssetResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAssetResponsibility->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | InPlaceAssetResponsibility->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAssetResponsibility->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | InPlaceAssetResponsibility->Unsynchronised | boolean | |\r\n| createdByUserId | InPlaceAssetResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetResponsibility->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetResponsibility->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetResponsibility->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetResponsibility->InPlaceAsset_Description | string | |\r\n| notes | InPlaceAssetResponsibility->Notes | string | |\r\n| recordType | InPlaceAssetResponsibility->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | InPlaceAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | InPlaceAssetResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | InPlaceAssetResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | InPlaceAssetResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | InPlaceAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | InPlaceAssetResponsibility->Section_Code | string | |\r\n| sectionDescription | InPlaceAssetResponsibility->Section_Description | string | |\r\n| tradeId | InPlaceAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | InPlaceAssetResponsibility->Trade_Code | string | |\r\n| tradeDescription | InPlaceAssetResponsibility->Trade_Description | string | |\r\n", "operationId": "GetInPlaceAssetResponsibility", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Responsibility", "schema": { "$ref": "#/definitions/GetInPlaceAssetResponsibilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Update an existing In-Place Asset 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 | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetResponsibility->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateInPlaceAssetResponsibility", "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 Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset 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" } } }, "delete": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Delete an existing In-Place Asset 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 | InPlaceAssetResponsibility->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": "DeleteInPlaceAssetResponsibility", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteInPlaceAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Responsibility 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/InPlaceAssets/Responsibilities": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| isActive | InPlaceAssetResponsibility->IsActive | boolean | |\r\n| inPlaceAssetCode | InPlaceAssetResponsibility->InPlaceAsset_Code | string | |\r\n| tradeCode | InPlaceAssetResponsibility->Trade_Code | string | |\r\n| sectionCode | InPlaceAssetResponsibility->Section_Code | string | |\r\n| resourceCode | InPlaceAssetResponsibility->Resource_Code | string | |\r\n| inheritedFromId | InPlaceAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| isInherited | InPlaceAssetResponsibility->IsInherited | boolean | |\r\n| developmentStatus | InPlaceAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n", "operationId": "GetInPlaceAssetResponsibilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Responsibility collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetResponsibilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Create a new In-Place Asset 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| permissionTreeId | InPlaceAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetResponsibility->InPlaceAsset_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetResponsibility->Notes | string | |\r\n\r\n#### Business 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| inPlaceAssetId | Nullable | False | |\r\n| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "CreateInPlaceAssetResponsibility", "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/CreateInPlaceAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Responsibilities": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Get a collection of responsibility resources for the In-Place Asset.", "description": "### Response Body\r\n#### 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 | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| id | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| resourceId | InPlaceAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetResponsibility->Resource_Code | string | |\r\n| tradeId | InPlaceAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | InPlaceAssetResponsibility->Trade_Code | string | |\r\n| sectionId | InPlaceAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | InPlaceAssetResponsibility->Section_Code | string | |\r\n| notes | InPlaceAssetResponsibility->Notes | string | |\r\n| developmentStatus | InPlaceAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | InPlaceAssetResponsibility->IsInherited | boolean | |\r\n", "operationId": "GetInPlaceAssetResponsibilityForInPlaceAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Responsibility collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetResponsibilityForInPlaceAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Lookups/LookupInPlaceAssetResponsibilityChangePermissionTree": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Lookup the permission set for changing the In-Place Asset 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": "LookupInPlaceAssetResponsibilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetResponsibilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Lookups/LookupInPlaceAssetResponsibilityInPlaceAsset": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Lookup the In-Place Asset for the In-Place Asset 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 | InPlaceAsset->Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n", "operationId": "LookupInPlaceAssetResponsibilityInPlaceAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/InPlaceAssetResponsibilityInPlaceAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Lookups/LookupInPlaceAssetResponsibilityInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Lookup the permission set for creating the In-Place Asset 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": "LookupInPlaceAssetResponsibilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Lookups/LookupInPlaceAssetResponsibilityResource": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Lookup the Resource for the In-Place Asset 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": "LookupInPlaceAssetResponsibilityResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetResponsibilityResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Lookups/LookupInPlaceAssetResponsibilityResourceWithTradeFilter": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Lookup the Resource for the In-Place Asset 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": "LookupInPlaceAssetResponsibilityResourceWithTradeFilter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Lookups/LookupInPlaceAssetResponsibilitySection": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Lookup the Section for the In-Place Asset 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": "LookupInPlaceAssetResponsibilitySection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetResponsibilitySectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Lookups/LookupInPlaceAssetResponsibilityTrade": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Lookup the Trade for the In-Place Asset 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": "LookupInPlaceAssetResponsibilityTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetResponsibilityTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| isActive | InPlaceAssetResponsibility->IsActive | boolean | |\r\n| isHistorical | InPlaceAssetResponsibility->IsHistorical | boolean | |\r\n| isInherited | InPlaceAssetResponsibility->IsInherited | boolean | |\r\n| isProposed | InPlaceAssetResponsibility->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAssetResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAssetResponsibility->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | InPlaceAssetResponsibility->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAssetResponsibility->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | InPlaceAssetResponsibility->Unsynchronised | boolean | |\r\n| createdByUserId | InPlaceAssetResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetResponsibility->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetResponsibility->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetResponsibility->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetResponsibility->InPlaceAsset_Description | string | |\r\n| notes | InPlaceAssetResponsibility->Notes | string | |\r\n| recordType | InPlaceAssetResponsibility->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | InPlaceAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | InPlaceAssetResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | InPlaceAssetResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | InPlaceAssetResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | InPlaceAssetResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | InPlaceAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | InPlaceAssetResponsibility->Section_Code | string | |\r\n| sectionDescription | InPlaceAssetResponsibility->Section_Description | string | |\r\n| tradeId | InPlaceAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | InPlaceAssetResponsibility->Trade_Code | string | |\r\n| tradeDescription | InPlaceAssetResponsibility->Trade_Description | string | |\r\n", "operationId": "BatchGetInPlaceAssetResponsibility", "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 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 Responsibility collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetResponsibilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Batch": { "post": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Create a new collection of In-Place Asset 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| permissionTreeId | InPlaceAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| inPlaceAssetId | InPlaceAssetResponsibility->InPlaceAsset_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetResponsibility->Notes | string | |\r\n\r\n#### Business 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| inPlaceAssetId | Nullable | False | |\r\n| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateInPlaceAssetResponsibility", "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/BatchCreateInPlaceAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - In-Place Asset 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 Responsibility" ], "summary": "Update a collection of existing In-Place Asset 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 | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | InPlaceAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | InPlaceAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | InPlaceAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | InPlaceAssetResponsibility->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateInPlaceAssetResponsibility", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateInPlaceAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset 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" } } }, "delete": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Delete a collection of existing In-Place Asset 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 | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetResponsibility->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteInPlaceAssetResponsibility", "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/BatchDeleteInPlaceAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Responsibility 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/InPlaceAssets/Responsibilities/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Accept the Development Status for an existing In-Place Asset Responsibility resource.", "description": "", "operationId": "AcceptInPlaceAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Responsibility resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Responsibility id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Responsibility resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Responsibility id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/{id}/Active": { "patch": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Change the IsActive status for an existing In-Place Asset 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 | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| isActive | InPlaceAssetResponsibility->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": "ChangeInPlaceAssetResponsibilityIsActive", "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 Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetResponsibilityIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Change the PermissionTree for an existing In-Place Asset 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 | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetResponsibility->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": "ChangeInPlaceAssetResponsibilityPermissionTree", "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 Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetResponsibilityPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Reject the Development Status for an existing In-Place Asset Responsibility resource.", "description": "", "operationId": "RejectInPlaceAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Responsibilities/Batch/Active": { "patch": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset 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 | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| isActive | InPlaceAssetResponsibility->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": "BatchChangeInPlaceAssetResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetResponsibilityIsActiveResourceActionRequest" } }, { "$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/InPlaceAssets/Responsibilities/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset Responsibility" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset 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 | InPlaceAssetResponsibility->Id | integer | int64 |\r\n| version | InPlaceAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetResponsibility->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": "BatchChangeInPlaceAssetResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetResponsibilityPermissionTreeResourceActionRequest" } }, { "$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/InPlaceAssets/Spares/{id}": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Get a In-Place Asset 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 | InPlaceAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | InPlaceAssetSpare->Id | integer | int64 |\r\n| isActive | InPlaceAssetSpare->IsActive | boolean | |\r\n| isHistorical | InPlaceAssetSpare->IsHistorical | boolean | |\r\n| isInherited | InPlaceAssetSpare->IsInherited | boolean | |\r\n| isProposed | InPlaceAssetSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAssetSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAssetSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | InPlaceAssetSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAssetSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | InPlaceAssetSpare->Unsynchronised | boolean | |\r\n| createdByUserId | InPlaceAssetSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetSpare->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetSpare->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | InPlaceAssetSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromMaterialMasterId | InPlaceAssetSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | InPlaceAssetSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | InPlaceAssetSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| inPlaceAssetId | InPlaceAssetSpare->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetSpare->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetSpare->InPlaceAsset_Description | string | |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetSpare->MaterialMaster_Description | string | |\r\n| notes | InPlaceAssetSpare->Notes | string | |\r\n| recordType | InPlaceAssetSpare->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetInPlaceAssetSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains In-Place Asset Spare", "schema": { "$ref": "#/definitions/GetInPlaceAssetSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "In-Place Asset Spare" ], "summary": "Update an existing In-Place Asset 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 | InPlaceAssetSpare->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetSpare->Notes | string | |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| materialMasterId | Nullable | False | |\r\n\r\n", "operationId": "UpdateInPlaceAssetSpare", "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 Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateInPlaceAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Spare was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "In-Place Asset Spare" ], "summary": "Delete an existing In-Place Asset 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 | InPlaceAssetSpare->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": "DeleteInPlaceAssetSpare", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteInPlaceAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Spare was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAssetSpare->Id | integer | int64 |\r\n| version | InPlaceAssetSpare->Version | integer | int32 |\r\n| inPlaceAssetId | InPlaceAssetSpare->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetSpare->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetSpare->InPlaceAsset_Description | string | |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetSpare->MaterialMaster_Description | string | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| developmentStatus | InPlaceAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | InPlaceAssetSpare->IsInherited | boolean | |\r\n", "operationId": "GetInPlaceAssetSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Spare collection", "schema": { "$ref": "#/definitions/GetInPlaceAssetSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "In-Place Asset Spare" ], "summary": "Create a new In-Place Asset 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| inPlaceAssetId | InPlaceAssetSpare->InPlaceAsset_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | Nullable | False | |\r\n| inPlaceAssetId | 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": "CreateInPlaceAssetSpare", "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/CreateInPlaceAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/{id}/Spares": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Get a collection of Spare resources for the InPlace Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | InPlaceAssetSpare->Id | integer | int64 |\r\n| version | InPlaceAssetSpare->Version | integer | int32 |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetSpare->MaterialMaster_Description | string | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| developmentStatus | InPlaceAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | InPlaceAssetSpare->IsInherited | boolean | |\r\n", "operationId": "GetInPlaceAssetSpareForInPlaceAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable In-Place Asset Spare collection", "schema": { "$ref": "#/definitions/GetSpareForInPlaceAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Lookups/LookupInPlaceAssetSpareChangePermissionTree": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Lookup the permission set for changing the In-Place Asset 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": "LookupInPlaceAssetSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Lookups/LookupInPlaceAssetSpareInPlaceAsset": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Lookup the In-Place Asset for the In-Place Asset 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 | InPlaceAsset->Id | integer | int64 |\r\n| code | InPlaceAsset->Code | string | |\r\n| description | InPlaceAsset->Description | string | |\r\n", "operationId": "LookupInPlaceAssetSpareInPlaceAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/InPlaceAssetSpareInPlaceAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Lookups/LookupInPlaceAssetSpareInsertPermissionTree": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Lookup the permission set for creating the In-Place Asset 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": "LookupInPlaceAssetSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Lookups/LookupInPlaceAssetSpareMaterialMaster": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Lookup the Material Master for the In-Place Asset 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": "LookupInPlaceAssetSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/InPlaceAssetSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Batch/{ids}": { "get": { "tags": [ "In-Place Asset Spare" ], "summary": "Get a collection of In-Place Asset 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 | InPlaceAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | InPlaceAssetSpare->Id | integer | int64 |\r\n| isActive | InPlaceAssetSpare->IsActive | boolean | |\r\n| isHistorical | InPlaceAssetSpare->IsHistorical | boolean | |\r\n| isInherited | InPlaceAssetSpare->IsInherited | boolean | |\r\n| isProposed | InPlaceAssetSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | InPlaceAssetSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | InPlaceAssetSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | InPlaceAssetSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | InPlaceAssetSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | InPlaceAssetSpare->Unsynchronised | boolean | |\r\n| createdByUserId | InPlaceAssetSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | InPlaceAssetSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | InPlaceAssetSpare->CreatedByUser_FullName | string | |\r\n| createdOn | InPlaceAssetSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | InPlaceAssetSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | InPlaceAssetSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | InPlaceAssetSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | InPlaceAssetSpare->ModifiedOn | string | date-time |\r\n| version | InPlaceAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | InPlaceAssetSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | InPlaceAssetSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | InPlaceAssetSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | InPlaceAssetSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromMaterialMasterId | InPlaceAssetSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | InPlaceAssetSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | InPlaceAssetSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| inPlaceAssetId | InPlaceAssetSpare->InPlaceAsset_Id | integer | int64 |\r\n| inPlaceAssetCode | InPlaceAssetSpare->InPlaceAsset_Code | string | |\r\n| inPlaceAssetDescription | InPlaceAssetSpare->InPlaceAsset_Description | string | |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | InPlaceAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | InPlaceAssetSpare->MaterialMaster_Description | string | |\r\n| notes | InPlaceAssetSpare->Notes | string | |\r\n| recordType | InPlaceAssetSpare->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "BatchGetInPlaceAssetSpare", "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 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 Spare collection", "schema": { "$ref": "#/definitions/BatchGetInPlaceAssetSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Batch": { "post": { "tags": [ "In-Place Asset Spare" ], "summary": "Create a new collection of In-Place Asset 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| inPlaceAssetId | InPlaceAssetSpare->InPlaceAsset_Id | integer | int64 |\r\n| permissionTreeId | InPlaceAssetSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | InPlaceAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| inPlaceAssetId | Required | True | |\r\n| inPlaceAssetId | Nullable | False | |\r\n| inPlaceAssetId | 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": "BatchCreateInPlaceAssetSpare", "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/BatchCreateInPlaceAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - In-Place Asset 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 Spare" ], "summary": "Update a collection of existing In-Place Asset 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 | InPlaceAssetSpare->Id | integer | int64 |\r\n| version | InPlaceAssetSpare->Version | integer | int32 |\r\n| sequenceNumber | InPlaceAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | InPlaceAssetSpare->IsCritical | boolean | |\r\n| isEmergency | InPlaceAssetSpare->IsEmergency | boolean | |\r\n| notes | InPlaceAssetSpare->Notes | string | |\r\n| materialMasterId | InPlaceAssetSpare->MaterialMaster_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| materialMasterId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateInPlaceAssetSpare", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateInPlaceAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Spare batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "In-Place Asset Spare" ], "summary": "Delete a collection of existing In-Place Asset 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 | InPlaceAssetSpare->Id | integer | int64 |\r\n| version | InPlaceAssetSpare->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteInPlaceAssetSpare", "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/BatchDeleteInPlaceAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - In-Place Asset Spare batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Spare" ], "summary": "Accept the Development Status for an existing In-Place Asset Spare resource.", "description": "", "operationId": "AcceptInPlaceAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "In-Place Asset Spare" ], "summary": "Accept the Development Status for the collection of existing In-Place Asset Spare resource id's.", "description": "", "operationId": "BatchAcceptInPlaceAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Spare" ], "summary": "Reject the Development Status for the collection of existing In-Place Asset Spare resource id's.", "description": "", "operationId": "BatchRejectInPlaceAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of In-Place Asset Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/{id}/Active": { "patch": { "tags": [ "In-Place Asset Spare" ], "summary": "Change the IsActive status for an existing In-Place Asset 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 | InPlaceAssetSpare->Version | integer | int32 |\r\n| isActive | InPlaceAssetSpare->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": "ChangeInPlaceAssetSpareIsActive", "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 Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetSpareIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/{id}/PermissionTree": { "patch": { "tags": [ "In-Place Asset Spare" ], "summary": "Change the PermissionTree for an existing In-Place Asset 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 | InPlaceAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetSpare->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": "ChangeInPlaceAssetSparePermissionTree", "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 Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeInPlaceAssetSparePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "In-Place Asset Spare" ], "summary": "Reject the Development Status for an existing In-Place Asset Spare resource.", "description": "", "operationId": "RejectInPlaceAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "In-Place Asset Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/InPlaceAssets/Spares/Batch/Active": { "patch": { "tags": [ "In-Place Asset Spare" ], "summary": "Change the IsActive status for a collection of existing In-Place Asset 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 | InPlaceAssetSpare->Id | integer | int64 |\r\n| version | InPlaceAssetSpare->Version | integer | int32 |\r\n| isActive | InPlaceAssetSpare->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": "BatchChangeInPlaceAssetSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetSpareIsActiveResourceActionRequest" } }, { "$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/InPlaceAssets/Spares/Batch/PermissionTree": { "patch": { "tags": [ "In-Place Asset Spare" ], "summary": "Change the PermissionTree status for a collection of existing In-Place Asset 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 | InPlaceAssetSpare->Id | integer | int64 |\r\n| version | InPlaceAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | InPlaceAssetSpare->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": "BatchChangeInPlaceAssetSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeInPlaceAssetSparePermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssets/{id}": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Get a Placeholder Asset 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| calendarId | PlaceholderAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | PlaceholderAsset->Calendar_Code | string | |\r\n| calendarDescription | PlaceholderAsset->Calendar_Description | string | |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | PlaceholderAsset->CostCentre_Code | string | |\r\n| costCentreDescription | PlaceholderAsset->CostCentre_Description | string | |\r\n| developmentStatus | PlaceholderAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | PlaceholderAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | PlaceholderAsset->GeneralLedger_Description | string | |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| isActive | PlaceholderAsset->IsActive | boolean | |\r\n| isHistorical | PlaceholderAsset->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAsset->IsInherited | boolean | |\r\n| isProposed | PlaceholderAsset->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAsset->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAsset->LastConfirmedOn | string | date-time |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| locationCode | PlaceholderAsset->Location_Code | string | |\r\n| locationDescription | PlaceholderAsset->Location_Description | string | |\r\n| nearestRegularAssetId | PlaceholderAsset->NearestRegularAsset_Id | integer | int64 |\r\n| parentAssetId | PlaceholderAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | PlaceholderAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | PlaceholderAsset->ParentAsset_Description | string | |\r\n| parentAssetRecordType | PlaceholderAsset->ParentAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| siteId | PlaceholderAsset->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAsset->Site_Code | string | |\r\n| siteDescription | PlaceholderAsset->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAsset->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationFailedReason | PlaceholderAsset->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | PlaceholderAsset->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | PlaceholderAsset->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | PlaceholderAsset->Unsubscribed | boolean | |\r\n| code | PlaceholderAsset->Code | string | |\r\n| geographicId | PlaceholderAsset->GeographicId | integer | int64 |\r\n| geographicEndPosition | PlaceholderAsset->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | PlaceholderAsset->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | PlaceholderAsset->GeographicLength | number | decimal |\r\n| geographicLocation | PlaceholderAsset->GeographicLocation | object | |\r\n| geographicNotes | PlaceholderAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityId | PlaceholderAsset->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | PlaceholderAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | PlaceholderAsset->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | PlaceholderAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | PlaceholderAsset->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | PlaceholderAsset->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | PlaceholderAsset->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAsset->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAsset->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAsset->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAsset->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAsset->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAsset->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAsset->ModifiedOn | string | date-time |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAsset->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAsset->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAsset->PermissionTree_Description | string | |\r\n| treePathId | PlaceholderAsset->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAsset->TreePathItems | array | array |\r\n| acquisitionStatusId | PlaceholderAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | PlaceholderAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | PlaceholderAsset->AcquisitionStatus_Description | string | |\r\n| acquisitionTypeId | PlaceholderAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | PlaceholderAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | PlaceholderAsset->AcquisitionType_Description | string | |\r\n| alternativeDescription | PlaceholderAsset->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAsset->AssetImportance_Description | string | |\r\n| assetTypeId | PlaceholderAsset->AssetType_Id | integer | int64 |\r\n| assetTypeRecordType | PlaceholderAsset->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeCode | PlaceholderAsset->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAsset->AssetType_Description | string | |\r\n| barcode | PlaceholderAsset->Barcode | string | |\r\n| budgetedReplacementAmount | PlaceholderAsset->BudgetedReplacementAmount | number | decimal |\r\n| commissionedOn | PlaceholderAsset->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | PlaceholderAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | PlaceholderAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | PlaceholderAsset->CommissioningWorkOrder_Description | string | |\r\n| currentValue | PlaceholderAsset->CurrentValue | number | decimal |\r\n| dateOfCurrentValue | PlaceholderAsset->DateOfCurrentValue | string | date |\r\n| description | PlaceholderAsset->Description | string | |\r\n| downtimeCostPerHour | PlaceholderAsset->DowntimeCostPerHour | number | decimal |\r\n| expectedReplacementDate | PlaceholderAsset->ExpectedReplacementDate | string | date |\r\n| inheritedFromId | PlaceholderAsset->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAsset->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| insuredValue | PlaceholderAsset->InsuredValue | number | decimal |\r\n| isForScheduledWorkOnly | PlaceholderAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | PlaceholderAsset->IsMsi | boolean | |\r\n| isPermitRequired | PlaceholderAsset->IsPermitRequired | boolean | |\r\n| isRunning | PlaceholderAsset->IsRunning | boolean | |\r\n| linkedOnTypeSide | PlaceholderAsset->LinkedOnTypeSide | boolean | |\r\n| notes | PlaceholderAsset->Notes | string | |\r\n| purchaseAmount | PlaceholderAsset->PurchaseAmount | number | decimal |\r\n| qRCode | PlaceholderAsset->QRCode | string | |\r\n| recordType | PlaceholderAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | PlaceholderAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | PlaceholderAsset->ReplacementAsset_Description | string | |\r\n| rFId | PlaceholderAsset->RFId | string | |\r\n| serialNumber | PlaceholderAsset->SerialNumber | string | |\r\n| supplierId | PlaceholderAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAsset->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAsset->Supplier_Description | string | |\r\n| taskRollUpPointId | PlaceholderAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | PlaceholderAsset->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | PlaceholderAsset->TaskRollUpPoint_Description | string | |\r\n| warranty | PlaceholderAsset->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetPlaceholderAsset", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset", "schema": { "$ref": "#/definitions/GetPlaceholderAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset" ], "summary": "Update an existing Placeholder Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| alternativeDescription | PlaceholderAsset->AlternativeDescription | string | |\r\n| qRCode | PlaceholderAsset->QRCode | string | |\r\n| rFId | PlaceholderAsset->RFId | string | |\r\n| serialNumber | PlaceholderAsset->SerialNumber | string | |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| barcode | PlaceholderAsset->Barcode | string | |\r\n| isPermitRequired | PlaceholderAsset->IsPermitRequired | boolean | |\r\n| isRunning | PlaceholderAsset->IsRunning | boolean | |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | PlaceholderAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| calendarId | PlaceholderAsset->Calendar_Id | integer | int64 |\r\n| isForScheduledWorkOnly | PlaceholderAsset->IsForScheduledWorkOnly | boolean | |\r\n| commissioningWorkOrderId | PlaceholderAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | PlaceholderAsset->PurchaseAmount | number | decimal |\r\n| currentValue | PlaceholderAsset->CurrentValue | number | decimal |\r\n| supplierId | PlaceholderAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | PlaceholderAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | PlaceholderAsset->AcquisitionStatus_Id | integer | int64 |\r\n| budgetedReplacementAmount | PlaceholderAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | PlaceholderAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | PlaceholderAsset->InsuredValue | number | decimal |\r\n| commissionedOn | PlaceholderAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | PlaceholderAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | PlaceholderAsset->DateOfCurrentValue | string | date |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| notes | PlaceholderAsset->Notes | string | |\r\n| geographicLocation | PlaceholderAsset->GeographicLocation | object | |\r\n| geographicStartPosition | PlaceholderAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | PlaceholderAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | PlaceholderAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | PlaceholderAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | PlaceholderAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | PlaceholderAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | PlaceholderAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Read-only | True | PlaceholderAsset->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 | PlaceholderAsset->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| calendarId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAsset", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-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": [ "Placeholder Asset" ], "summary": "Delete an existing Placeholder Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAsset->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": "DeletePlaceholderAsset", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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/PlaceholderAssets": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAsset->Version | integer | int32 |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| isActive | PlaceholderAsset->IsActive | boolean | |\r\n| siteId | PlaceholderAsset->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAsset->Site_Code | string | |\r\n| parentAssetId | PlaceholderAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | PlaceholderAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | PlaceholderAsset->ParentAsset_Description | string | |\r\n| assetTypeId | PlaceholderAsset->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAsset->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAsset->AssetType_Description | string | |\r\n| developmentStatus | PlaceholderAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAsset->IsInherited | boolean | |\r\n| isMsi | PlaceholderAsset->IsMsi | boolean | |\r\n| inheritedFromId | PlaceholderAsset->InheritedFrom_Id | integer | int64 |\r\n| rulesLastEvaluatedOn | PlaceholderAsset->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | PlaceholderAsset->RuleEvaluationPassed | boolean | |\r\n| treePathItems | PlaceholderAsset->TreePathItems | array | array |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | PlaceholderAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | PlaceholderAsset->ReplacementAsset_Description | string | |\r\n| recordType | PlaceholderAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetPlaceholderAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset" ], "summary": "Create a new Placeholder Asset resource.", "description": "### Request Body\r\n#### 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 | PlaceholderAsset->PermissionTree_Id | integer | int64 |\r\n| siteId | PlaceholderAsset->Site_Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| alternativeDescription | PlaceholderAsset->AlternativeDescription | string | |\r\n| isPermitRequired | PlaceholderAsset->IsPermitRequired | boolean | |\r\n| isRunning | PlaceholderAsset->IsRunning | boolean | |\r\n| parentAssetId | PlaceholderAsset->ParentAsset_Id | integer | int64 |\r\n| qRCode | PlaceholderAsset->QRCode | string | |\r\n| rFId | PlaceholderAsset->RFId | string | |\r\n| serialNumber | PlaceholderAsset->SerialNumber | string | |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| barcode | PlaceholderAsset->Barcode | string | |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | PlaceholderAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| commissioningWorkOrderId | PlaceholderAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| isForScheduledWorkOnly | PlaceholderAsset->IsForScheduledWorkOnly | boolean | |\r\n| calendarId | PlaceholderAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | PlaceholderAsset->PurchaseAmount | number | decimal |\r\n| currentValue | PlaceholderAsset->CurrentValue | number | decimal |\r\n| supplierId | PlaceholderAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | PlaceholderAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | PlaceholderAsset->AcquisitionStatus_Id | integer | int64 |\r\n| budgetedReplacementAmount | PlaceholderAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | PlaceholderAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | PlaceholderAsset->InsuredValue | number | decimal |\r\n| commissionedOn | PlaceholderAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | PlaceholderAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | PlaceholderAsset->DateOfCurrentValue | string | date |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| notes | PlaceholderAsset->Notes | string | |\r\n| geographicLocation | PlaceholderAsset->GeographicLocation | object | |\r\n| geographicStartPosition | PlaceholderAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | PlaceholderAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | PlaceholderAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | PlaceholderAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | PlaceholderAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | PlaceholderAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | PlaceholderAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | 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| 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| isPermitRequired | Required | True | |\r\n| isPermitRequired | Nullable | False | |\r\n| parentAssetId | Required | True | |\r\n| parentAssetId | Nullable | False | |\r\n| parentAssetId | Min Value | > 1| |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| calendarId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAsset", "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/CreatePlaceholderAssetResourceActionRequest" } }, { "$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/PlaceholderAssets/Lookups/LookupPlaceholderAssetAcquisitionStatus": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Acquisition Status for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AcquisitionStatus->Id | integer | int64 |\r\n| code | AcquisitionStatus->Code | string | |\r\n| description | AcquisitionStatus->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetAcquisitionStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Acquisition Status collection", "schema": { "$ref": "#/definitions/PlaceholderAssetAcquisitionStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetAcquisitionType": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Acquisition Type for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AcquisitionType->Id | integer | int64 |\r\n| code | AcquisitionType->Code | string | |\r\n| description | AcquisitionType->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetAcquisitionType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Acquisition Type collection", "schema": { "$ref": "#/definitions/PlaceholderAssetAcquisitionTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetAssetParent": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Placeholder Asset for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupPlaceholderAssetAssetParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/PlaceholderAssetAssetParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetAssetTypeParent": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Placeholder Asset for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\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| canSelectOnAsset | AssetType->CanSelectOnAsset | boolean | |\r\n", "operationId": "LookupPlaceholderAssetAssetTypeParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetAssetTypeParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetCalendar": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Calendar for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Calendar->Id | integer | int64 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetCalendar", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Calendar collection", "schema": { "$ref": "#/definitions/PlaceholderAssetCalendarLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetChangePermissionTree": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the permission set for changing the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetCommissioningWorkOrder": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Work Order for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetCommissioningWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Work Order collection", "schema": { "$ref": "#/definitions/PlaceholderAssetCommissioningWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetCostCentre": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Cost Centre for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/PlaceholderAssetCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetGeneralLedger": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the General Ledger for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/PlaceholderAssetGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetImportance": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Asset Importance for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the permission set for creating the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetLocation": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Location for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetLocation", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Location collection", "schema": { "$ref": "#/definitions/PlaceholderAssetLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetReplacementAsset": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Replacement Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetReplacementAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetReplacementAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetSite": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Site for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/PlaceholderAssetSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetSupplier": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Supplier for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Lookups/LookupPlaceholderAssetTaskRollUpPoint": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Lookup the Task Roll Up Point for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset" ], "summary": "Get a collection of Placeholder Asset 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| calendarId | PlaceholderAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | PlaceholderAsset->Calendar_Code | string | |\r\n| calendarDescription | PlaceholderAsset->Calendar_Description | string | |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | PlaceholderAsset->CostCentre_Code | string | |\r\n| costCentreDescription | PlaceholderAsset->CostCentre_Description | string | |\r\n| developmentStatus | PlaceholderAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | PlaceholderAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | PlaceholderAsset->GeneralLedger_Description | string | |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| isActive | PlaceholderAsset->IsActive | boolean | |\r\n| isHistorical | PlaceholderAsset->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAsset->IsInherited | boolean | |\r\n| isProposed | PlaceholderAsset->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAsset->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAsset->LastConfirmedOn | string | date-time |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| locationCode | PlaceholderAsset->Location_Code | string | |\r\n| locationDescription | PlaceholderAsset->Location_Description | string | |\r\n| nearestRegularAssetId | PlaceholderAsset->NearestRegularAsset_Id | integer | int64 |\r\n| parentAssetId | PlaceholderAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | PlaceholderAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | PlaceholderAsset->ParentAsset_Description | string | |\r\n| parentAssetRecordType | PlaceholderAsset->ParentAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| siteId | PlaceholderAsset->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAsset->Site_Code | string | |\r\n| siteDescription | PlaceholderAsset->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAsset->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationFailedReason | PlaceholderAsset->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | PlaceholderAsset->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | PlaceholderAsset->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | PlaceholderAsset->Unsubscribed | boolean | |\r\n| code | PlaceholderAsset->Code | string | |\r\n| geographicId | PlaceholderAsset->GeographicId | integer | int64 |\r\n| geographicEndPosition | PlaceholderAsset->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | PlaceholderAsset->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | PlaceholderAsset->GeographicLength | number | decimal |\r\n| geographicLocation | PlaceholderAsset->GeographicLocation | object | |\r\n| geographicNotes | PlaceholderAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityId | PlaceholderAsset->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | PlaceholderAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | PlaceholderAsset->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | PlaceholderAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | PlaceholderAsset->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | PlaceholderAsset->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | PlaceholderAsset->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAsset->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAsset->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAsset->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAsset->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAsset->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAsset->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAsset->ModifiedOn | string | date-time |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAsset->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAsset->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAsset->PermissionTree_Description | string | |\r\n| treePathId | PlaceholderAsset->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAsset->TreePathItems | array | array |\r\n| acquisitionStatusId | PlaceholderAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | PlaceholderAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | PlaceholderAsset->AcquisitionStatus_Description | string | |\r\n| acquisitionTypeId | PlaceholderAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | PlaceholderAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | PlaceholderAsset->AcquisitionType_Description | string | |\r\n| alternativeDescription | PlaceholderAsset->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAsset->AssetImportance_Description | string | |\r\n| assetTypeId | PlaceholderAsset->AssetType_Id | integer | int64 |\r\n| assetTypeRecordType | PlaceholderAsset->AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTypeCode | PlaceholderAsset->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAsset->AssetType_Description | string | |\r\n| barcode | PlaceholderAsset->Barcode | string | |\r\n| budgetedReplacementAmount | PlaceholderAsset->BudgetedReplacementAmount | number | decimal |\r\n| commissionedOn | PlaceholderAsset->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | PlaceholderAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | PlaceholderAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | PlaceholderAsset->CommissioningWorkOrder_Description | string | |\r\n| currentValue | PlaceholderAsset->CurrentValue | number | decimal |\r\n| dateOfCurrentValue | PlaceholderAsset->DateOfCurrentValue | string | date |\r\n| description | PlaceholderAsset->Description | string | |\r\n| downtimeCostPerHour | PlaceholderAsset->DowntimeCostPerHour | number | decimal |\r\n| expectedReplacementDate | PlaceholderAsset->ExpectedReplacementDate | string | date |\r\n| inheritedFromId | PlaceholderAsset->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAsset->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| insuredValue | PlaceholderAsset->InsuredValue | number | decimal |\r\n| isForScheduledWorkOnly | PlaceholderAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | PlaceholderAsset->IsMsi | boolean | |\r\n| isPermitRequired | PlaceholderAsset->IsPermitRequired | boolean | |\r\n| isRunning | PlaceholderAsset->IsRunning | boolean | |\r\n| linkedOnTypeSide | PlaceholderAsset->LinkedOnTypeSide | boolean | |\r\n| notes | PlaceholderAsset->Notes | string | |\r\n| purchaseAmount | PlaceholderAsset->PurchaseAmount | number | decimal |\r\n| qRCode | PlaceholderAsset->QRCode | string | |\r\n| recordType | PlaceholderAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | PlaceholderAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | PlaceholderAsset->ReplacementAsset_Description | string | |\r\n| rFId | PlaceholderAsset->RFId | string | |\r\n| serialNumber | PlaceholderAsset->SerialNumber | string | |\r\n| supplierId | PlaceholderAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAsset->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAsset->Supplier_Description | string | |\r\n| taskRollUpPointId | PlaceholderAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | PlaceholderAsset->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | PlaceholderAsset->TaskRollUpPoint_Description | string | |\r\n| warranty | PlaceholderAsset->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "BatchGetPlaceholderAsset", "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 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 collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Batch": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Create a new collection of Placeholder Asset resources.", "description": "### Request Body\r\n#### 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 | PlaceholderAsset->PermissionTree_Id | integer | int64 |\r\n| siteId | PlaceholderAsset->Site_Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| alternativeDescription | PlaceholderAsset->AlternativeDescription | string | |\r\n| parentAssetId | PlaceholderAsset->ParentAsset_Id | integer | int64 |\r\n| qRCode | PlaceholderAsset->QRCode | string | |\r\n| rFId | PlaceholderAsset->RFId | string | |\r\n| serialNumber | PlaceholderAsset->SerialNumber | string | |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| barcode | PlaceholderAsset->Barcode | string | |\r\n| isPermitRequired | PlaceholderAsset->IsPermitRequired | boolean | |\r\n| isRunning | PlaceholderAsset->IsRunning | boolean | |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | PlaceholderAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| commissioningWorkOrderId | PlaceholderAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| isForScheduledWorkOnly | PlaceholderAsset->IsForScheduledWorkOnly | boolean | |\r\n| calendarId | PlaceholderAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | PlaceholderAsset->PurchaseAmount | number | decimal |\r\n| currentValue | PlaceholderAsset->CurrentValue | number | decimal |\r\n| supplierId | PlaceholderAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | PlaceholderAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | PlaceholderAsset->AcquisitionStatus_Id | integer | int64 |\r\n| budgetedReplacementAmount | PlaceholderAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | PlaceholderAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | PlaceholderAsset->InsuredValue | number | decimal |\r\n| commissionedOn | PlaceholderAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | PlaceholderAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | PlaceholderAsset->DateOfCurrentValue | string | date |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| notes | PlaceholderAsset->Notes | string | |\r\n| geographicLocation | PlaceholderAsset->GeographicLocation | object | |\r\n| geographicStartPosition | PlaceholderAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | PlaceholderAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | PlaceholderAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | PlaceholderAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | PlaceholderAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | PlaceholderAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | PlaceholderAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | 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| 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| parentAssetId | Required | True | |\r\n| parentAssetId | Nullable | False | |\r\n| parentAssetId | Min Value | > 1| |\r\n| isPermitRequired | Required | True | |\r\n| isPermitRequired | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| calendarId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| generalLedgerId | Required | True | |\r\n| generalLedgerId | Nullable | False | |\r\n| costCentreId | Required | True | |\r\n| costCentreId | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAsset", "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/BatchCreatePlaceholderAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" ], "summary": "Update a collection of existing Placeholder Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| alternativeDescription | PlaceholderAsset->AlternativeDescription | string | |\r\n| qRCode | PlaceholderAsset->QRCode | string | |\r\n| rFId | PlaceholderAsset->RFId | string | |\r\n| serialNumber | PlaceholderAsset->SerialNumber | string | |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| barcode | PlaceholderAsset->Barcode | string | |\r\n| isMsi | PlaceholderAsset->IsMsi | boolean | |\r\n| isPermitRequired | PlaceholderAsset->IsPermitRequired | boolean | |\r\n| isRunning | PlaceholderAsset->IsRunning | boolean | |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | PlaceholderAsset->AssetImportance_Id | integer | int64 |\r\n| isForScheduledWorkOnly | PlaceholderAsset->IsForScheduledWorkOnly | boolean | |\r\n| commissioningWorkOrderId | PlaceholderAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| calendarId | PlaceholderAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | PlaceholderAsset->PurchaseAmount | number | decimal |\r\n| currentValue | PlaceholderAsset->CurrentValue | number | decimal |\r\n| supplierId | PlaceholderAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | PlaceholderAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | PlaceholderAsset->AcquisitionStatus_Id | integer | int64 |\r\n| budgetedReplacementAmount | PlaceholderAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | PlaceholderAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | PlaceholderAsset->InsuredValue | number | decimal |\r\n| commissionedOn | PlaceholderAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | PlaceholderAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | PlaceholderAsset->DateOfCurrentValue | string | date |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| notes | PlaceholderAsset->Notes | string | |\r\n| geographicLocation | PlaceholderAsset->GeographicLocation | object | |\r\n| geographicStartPosition | PlaceholderAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | PlaceholderAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | PlaceholderAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | PlaceholderAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | PlaceholderAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | PlaceholderAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | PlaceholderAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| 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 | PlaceholderAsset->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 | PlaceholderAsset->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| isMsi | Nullable | False | |\r\n| calendarId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| costCentreId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAsset", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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": [ "Placeholder Asset" ], "summary": "Delete a collection of existing Placeholder Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| version | PlaceholderAsset->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": "BatchDeletePlaceholderAsset", "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/BatchDeletePlaceholderAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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/PlaceholderAssets/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Accept the Development Status for an existing Placeholder Asset resource.", "description": "", "operationId": "AcceptPlaceholderAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Batch/{ids}/Sync": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Synchronise the collection of existing Placeholder Asset resource id's.", "description": "", "operationId": "BatchSyncPlaceholderAsset", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/{id}/Active": { "patch": { "tags": [ "Placeholder Asset" ], "summary": "Change the IsActive status for an existing Placeholder Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| isActive | PlaceholderAsset->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": "ChangePlaceholderAssetIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssets/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset" ], "summary": "Change the PermissionTree for an existing Placeholder Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAsset->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": "ChangePlaceholderAssetPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssets/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Reject the Development Status for an existing Placeholder Asset resource.", "description": "", "operationId": "RejectPlaceholderAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Sync/Resubscribe": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Accept the Development Status for an existing Placeholder Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "ResubscribePlaceholderAssetDevelopmentStatus", "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/ResubscribePlaceholderAssetDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/{id}/Sync": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Synchronise the existing Placeholder Asset resource.", "description": "", "operationId": "SyncPlaceholderAsset", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Sync/Unsubscribe": { "post": { "tags": [ "Placeholder Asset" ], "summary": "Accept the Development Status for an existing Placeholder Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "UnsubscribePlaceholderAssetDevelopmentStatus", "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/UnsubscribePlaceholderAssetDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Batch/Active": { "patch": { "tags": [ "Placeholder Asset" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| isActive | PlaceholderAsset->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": "BatchChangePlaceholderAssetIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssets/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAsset->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": "BatchChangePlaceholderAssetPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssets/MatchBatch": { "patch": { "tags": [ "Placeholder Asset" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAsset->Id | integer | int64 |\r\n| version | PlaceholderAsset->Version | integer | int32 |\r\n| description | PlaceholderAsset->Description | string | |\r\n| alternativeDescription | PlaceholderAsset->AlternativeDescription | string | |\r\n| qRCode | PlaceholderAsset->QRCode | string | |\r\n| rFId | PlaceholderAsset->RFId | string | |\r\n| serialNumber | PlaceholderAsset->SerialNumber | string | |\r\n| sequenceNumber | PlaceholderAsset->SequenceNumber | integer | int32 |\r\n| barcode | PlaceholderAsset->Barcode | string | |\r\n| isPermitRequired | PlaceholderAsset->IsPermitRequired | boolean | |\r\n| isRunning | PlaceholderAsset->IsRunning | boolean | |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | PlaceholderAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | PlaceholderAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| calendarId | PlaceholderAsset->Calendar_Id | integer | int64 |\r\n| isForScheduledWorkOnly | PlaceholderAsset->IsForScheduledWorkOnly | boolean | |\r\n| commissioningWorkOrderId | PlaceholderAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | PlaceholderAsset->PurchaseAmount | number | decimal |\r\n| currentValue | PlaceholderAsset->CurrentValue | number | decimal |\r\n| supplierId | PlaceholderAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | PlaceholderAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | PlaceholderAsset->AcquisitionStatus_Id | integer | int64 |\r\n| budgetedReplacementAmount | PlaceholderAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | PlaceholderAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | PlaceholderAsset->InsuredValue | number | decimal |\r\n| commissionedOn | PlaceholderAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | PlaceholderAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | PlaceholderAsset->DateOfCurrentValue | string | date |\r\n| replacementAssetId | PlaceholderAsset->ReplacementAsset_Id | integer | int64 |\r\n| notes | PlaceholderAsset->Notes | string | |\r\n\r\n#### Business Rules\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| description | Nullable | False | |\r\n| description | Read-only | True | PlaceholderAsset->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| calendarId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | PlaceholderAsset->IsMsi eq true |\r\n\r\n", "operationId": "MatchUpdatePlaceholderAsset", "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/MatchUpdatePlaceholderAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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/PlaceholderAssets/ActiveConditions/{id}": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Get a Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetActiveCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetActiveCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetActiveCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetActiveCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetActiveCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetActiveCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetActiveCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetActiveCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetActiveCondition->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetActiveCondition->Id | integer | int64 |\r\n| conditionId | PlaceholderAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetActiveCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| notes | PlaceholderAssetActiveCondition->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetActiveCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetActiveCondition->PlaceholderAsset_Description | string | |\r\n| placeholderAssetNearestRegularAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetNearestRegularAssetCode | PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetNearestRegularAssetDescription | PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Description | string | |\r\n| recordType | PlaceholderAssetActiveCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetActiveCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Active Condition", "schema": { "$ref": "#/definitions/GetPlaceholderAssetActiveConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Update an existing Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetActiveCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetActiveCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Active Condition was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Delete an existing Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->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": "DeletePlaceholderAssetActiveCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetActiveConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Active Condition was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Get a collection of Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetActiveCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetActiveCondition->PlaceholderAsset_Description | string | |\r\n| conditionId | PlaceholderAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetActiveConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Active Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetActiveConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Create a new Placeholder Asset Active Condition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetActiveCondition->Condition_Id | integer | int64 |\r\n| notes | PlaceholderAssetActiveCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetActiveCondition", "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/CreatePlaceholderAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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/PlaceholderAssets/{id}/ActiveConditions": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Get a collection of PlaceholderAssetActiveCondition resources for the PlaceholderAsset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetActiveCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetActiveCondition->PlaceholderAsset_Description | string | |\r\n| conditionId | PlaceholderAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetActiveConditionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Active Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetActiveConditionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Lookups/LookupPlaceholderAssetActiveConditionChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Lookup the permission set for changing the Placeholder Asset Active 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": "LookupPlaceholderAssetActiveConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetActiveConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Lookups/LookupPlaceholderAssetActiveConditionCondition": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Lookup the Condition Type for the Placeholder Asset Active 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| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetActiveConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetActiveConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Lookups/LookupPlaceholderAssetActiveConditionInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Lookup the permission set for creating the Placeholder Asset Active 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": "LookupPlaceholderAssetActiveConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetActiveConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Lookups/LookupPlaceholderAssetActiveConditionPlaceholderAsset": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Lookup the Placeholder Asset for the Placeholder Asset Active 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 | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetActiveConditionPlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetActiveConditionPlaceholderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Lookups/LookupPlaceholderAssetActiveConditionRegularAsset": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Lookup the Regular Asset for the Placeholder Asset Active 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetActiveConditionRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/PlaceholderAssetActiveConditionRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Get a collection of Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetActiveCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetActiveCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetActiveCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetActiveCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetActiveCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetActiveCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetActiveCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetActiveCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetActiveCondition->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetActiveCondition->Id | integer | int64 |\r\n| conditionId | PlaceholderAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetActiveCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| notes | PlaceholderAssetActiveCondition->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetActiveCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetActiveCondition->PlaceholderAsset_Description | string | |\r\n| placeholderAssetNearestRegularAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetNearestRegularAssetCode | PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetNearestRegularAssetDescription | PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Description | string | |\r\n| recordType | PlaceholderAssetActiveCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPlaceholderAssetActiveCondition", "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 Active 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 Active Condition collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetActiveConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Batch": { "post": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Create a new collection of Placeholder Asset Active Condition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetActiveCondition->PlaceholderAsset_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetActiveCondition->Condition_Id | integer | int64 |\r\n| notes | PlaceholderAssetActiveCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetActiveCondition", "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/BatchCreatePlaceholderAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Active 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 Active Condition" ], "summary": "Update a collection of existing Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| conditionId | PlaceholderAssetActiveCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetActiveCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| conditionId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetActiveCondition", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Active Condition batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Delete a collection of existing Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetActiveCondition->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeletePlaceholderAssetActiveCondition", "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/BatchDeletePlaceholderAssetActiveConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Active Condition batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetActiveCondition->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": "ChangePlaceholderAssetActiveConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetActiveConditionPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/ActiveConditions/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Active Condition" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Active 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 | PlaceholderAssetActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetActiveCondition->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": "BatchChangePlaceholderAssetActiveConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetActiveConditionPermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssets/Attributes/{id}": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Get a Placeholder Asset 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 | PlaceholderAssetAttribute->InheritedFrom_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetAttribute->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetAttribute->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetAttribute->PlaceholderAsset_Description | string | |\r\n| developmentStatus | PlaceholderAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | PlaceholderAssetAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | PlaceholderAssetAttribute->IsHistorical | boolean | |\r\n| unsynchronised | PlaceholderAssetAttribute->Unsynchronised | boolean | |\r\n| isInherited | PlaceholderAssetAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n", "operationId": "GetPlaceholderAssetAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Attribute", "schema": { "$ref": "#/definitions/GetPlaceholderAssetAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetAttribute->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": "DeletePlaceholderAssetAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/{placeholderAssetId}/Attributes": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Get a collection of Placeholder Asset Attribute resources for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetAttribute->IsInherited | boolean | |\r\n| attributeId | PlaceholderAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetAttributeCollectionForPlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "placeholderAssetId", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetAttributeCollectionForPlaceholderAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetAttribute->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetAttribute->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetAttribute->PlaceholderAsset_Description | string | |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetAttribute->IsInherited | boolean | |\r\n| attributeId | PlaceholderAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Create a new Placeholder Asset 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| placeholderAssetId | PlaceholderAssetAttribute->PlaceholderAsset_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | 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": "CreatePlaceholderAssetAttribute", "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/CreatePlaceholderAssetAttributeResourceActionRequest" } }, { "$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/PlaceholderAssets/Attributes/Lookups/LookupPlaceholderAssetAttributeAllowedValue": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Placeholder Asset 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": "LookupPlaceholderAssetAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Lookups/LookupPlaceholderAssetAttribute": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Lookup the Attribute for the Placeholder Asset 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": "LookupPlaceholderAssetAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Lookups/LookupPlaceholderAssetAttributeChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Lookups/LookupPlaceholderAssetAttributeInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Lookups/LookupPlaceholderAssetAttributePlaceholderAsset": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Lookup the Placeholder Asset Attribute for the Placeholder Asset 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 | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetAttributePlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetAttributePlaceholderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetAttribute->InheritedFrom_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetAttribute->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetAttribute->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetAttribute->PlaceholderAsset_Description | string | |\r\n| developmentStatus | PlaceholderAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | PlaceholderAssetAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | PlaceholderAssetAttribute->IsHistorical | boolean | |\r\n| unsynchronised | PlaceholderAssetAttribute->Unsynchronised | boolean | |\r\n| isInherited | PlaceholderAssetAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n", "operationId": "BatchGetPlaceholderAssetAttribute", "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 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 Attribute collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Batch": { "post": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Create a new collection of Placeholder Asset 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| placeholderAssetId | PlaceholderAssetAttribute->PlaceholderAsset_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | 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": "BatchCreatePlaceholderAssetAttribute", "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/BatchCreatePlaceholderAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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 Attribute" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdatePlaceholderAssetAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetAttribute->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": "BatchDeletePlaceholderAssetAttribute", "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/BatchDeletePlaceholderAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Accept the Development Status for an existing Placeholder Asset Attribute resource.", "description": "", "operationId": "AcceptPlaceholderAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Attribute resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Attribute resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetAttribute->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": "ChangePlaceholderAssetAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetAttributeIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetAttribute->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": "ChangePlaceholderAssetAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetAttributePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Reject the Development Status for an existing Placeholder Asset Attribute resource.", "description": "", "operationId": "RejectPlaceholderAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Attributes/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetAttribute->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": "BatchChangePlaceholderAssetAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetAttributeIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetAttribute->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": "BatchChangePlaceholderAssetAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetAttributePermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/{id}": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Get a Placeholder Asset 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| ruleEvaluationFailedReason | PlaceholderAssetComponent->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | PlaceholderAssetComponent->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | PlaceholderAssetComponent->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | PlaceholderAssetComponent->Unsubscribed | boolean | |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| createdByUserId | PlaceholderAssetComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponent->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponent->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponent->PermissionTree_Description | string | |\r\n| assetId | PlaceholderAssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | PlaceholderAssetComponent->Asset_Code | string | |\r\n| assetDescription | PlaceholderAssetComponent->Asset_Description | string | |\r\n| assetRecordType | PlaceholderAssetComponent->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetAssetTypeId | PlaceholderAssetComponent->Asset_AssetType_Id | integer | int64 |\r\n| assetAssetTypeRecordType | PlaceholderAssetComponent->Asset_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetNearestRegularAssetId | PlaceholderAssetComponent->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetCode | PlaceholderAssetComponent->Asset_NearestRegularAsset_Code | string | |\r\n| assetNearestRegularAssetDescription | PlaceholderAssetComponent->Asset_NearestRegularAsset_Description | string | |\r\n| assetTreePathId | PlaceholderAssetComponent->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | PlaceholderAssetComponent->Asset_TreePathItems | array | array |\r\n| developmentStatus | PlaceholderAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetComponent->Id | integer | int64 |\r\n| isActive | PlaceholderAssetComponent->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetComponent->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetComponent->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetComponent->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponent->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | PlaceholderAssetComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | PlaceholderAssetComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | PlaceholderAssetComponent->ParentComponent_Description | string | |\r\n| parentComponentTreePathId | PlaceholderAssetComponent->ParentComponent_TreePathId | integer | int64 |\r\n| parentComponentTreePathItems | PlaceholderAssetComponent->ParentComponent_TreePathItems | array | array |\r\n| recordType | PlaceholderAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| siteId | PlaceholderAssetComponent->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAssetComponent->Site_Code | string | |\r\n| siteDescription | PlaceholderAssetComponent->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponent->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetComponent->Unsynchronised | boolean | |\r\n| treePathId | PlaceholderAssetComponent->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAssetComponent->TreePathItems | array | array |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetComponent->AssetImportance_Description | string | |\r\n| assetTypeId | PlaceholderAssetComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetComponent->AssetType_Description | string | |\r\n| assetTypeTreePathId | PlaceholderAssetComponent->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | PlaceholderAssetComponent->AssetType_TreePathItems | array | array |\r\n| barcode | PlaceholderAssetComponent->Barcode | string | |\r\n| commissionedOn | PlaceholderAssetComponent->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | PlaceholderAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | PlaceholderAssetComponent->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | PlaceholderAssetComponent->CommissioningWorkOrder_Description | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| inheritedFromId | PlaceholderAssetComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAssetComponent->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromRulesLastChangedOn | PlaceholderAssetComponent->InheritedFrom_RulesLastChangedOn | string | date-time |\r\n| inheritedFromTreePathId | PlaceholderAssetComponent->InheritedFrom_TreePathId | integer | int64 |\r\n| inheritedFromTreePathItems | PlaceholderAssetComponent->InheritedFrom_TreePathItems | array | array |\r\n| linkedOnTypeSide | PlaceholderAssetComponent->LinkedOnTypeSide | boolean | |\r\n| linkedToAssetTypeId | PlaceholderAssetComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetComponent->LinkedToAssetType_Description | string | |\r\n| linkedToAssetTypeTreePathId | PlaceholderAssetComponent->LinkedToAssetType_TreePathId | integer | int64 |\r\n| linkedToAssetTypeTreePathItems | PlaceholderAssetComponent->LinkedToAssetType_TreePathItems | array | array |\r\n| materialMasterId | PlaceholderAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetComponent->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetComponent->Notes | string | |\r\n| partNumber | PlaceholderAssetComponent->PartNumber | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetComponent->PlaceholderForAssetType_Description | string | |\r\n| placeholderForAssetTypeTreePathId | PlaceholderAssetComponent->PlaceholderForAssetType_TreePathId | integer | int64 |\r\n| placeholderForAssetTypeTreePathItems | PlaceholderAssetComponent->PlaceholderForAssetType_TreePathItems | array | array |\r\n| qRCode | PlaceholderAssetComponent->QRCode | string | |\r\n| quantity | PlaceholderAssetComponent->Quantity | integer | int32 |\r\n| rFId | PlaceholderAssetComponent->RFId | string | |\r\n| serialNumber | PlaceholderAssetComponent->SerialNumber | string | |\r\n| specification | PlaceholderAssetComponent->Specification | string | |\r\n| supplierId | PlaceholderAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetComponent->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetComponent->Supplier_Description | string | |\r\n| supplierPartNumber | PlaceholderAssetComponent->SupplierPartNumber | string | |\r\n| warranty | PlaceholderAssetComponent->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Component", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| quantity | PlaceholderAssetComponent->Quantity | integer | int32 |\r\n| partNumber | PlaceholderAssetComponent->PartNumber | string | |\r\n| qRCode | PlaceholderAssetComponent->QRCode | string | |\r\n| rFId | PlaceholderAssetComponent->RFId | string | |\r\n| specification | PlaceholderAssetComponent->Specification | string | |\r\n| barcode | PlaceholderAssetComponent->Barcode | string | |\r\n| serialNumber | PlaceholderAssetComponent->SerialNumber | string | |\r\n| commissionedOn | PlaceholderAssetComponent->CommissionedOn | string | date |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| supplierId | PlaceholderAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetComponent->SupplierPartNumber | string | |\r\n| assetImportanceId | PlaceholderAssetComponent->AssetImportance_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| commissioningWorkOrderId | PlaceholderAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| notes | PlaceholderAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | PlaceholderAssetComponent->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 | PlaceholderAssetComponent->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| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 chars| |\r\n| specification | Min Length | >= 1 chars| |\r\n| specification | Max Length | <= 100 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| supplierPartNumber | Min Length | >= 1 chars| |\r\n| supplierPartNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "UpdatePlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Component" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetComponent->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": "DeletePlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component 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/PlaceholderAssetComponents": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| isActive | PlaceholderAssetComponent->IsActive | boolean | |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| partNumber | PlaceholderAssetComponent->PartNumber | string | |\r\n| qRCode | PlaceholderAssetComponent->QRCode | string | |\r\n| rFId | PlaceholderAssetComponent->RFId | string | |\r\n| specification | PlaceholderAssetComponent->Specification | string | |\r\n| supplierPartNumber | PlaceholderAssetComponent->SupplierPartNumber | string | |\r\n| commissionedOn | PlaceholderAssetComponent->CommissionedOn | string | date |\r\n| recordType | PlaceholderAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | PlaceholderAssetComponent->Quantity | integer | int32 |\r\n| assetImportanceId | PlaceholderAssetComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetComponent->AssetImportance_Description | string | |\r\n| assetTypeId | PlaceholderAssetComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetComponent->AssetType_Description | string | |\r\n| supplierId | PlaceholderAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetComponent->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetComponent->Supplier_Description | string | |\r\n| commissioningWorkOrderId | PlaceholderAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | PlaceholderAssetComponent->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | PlaceholderAssetComponent->CommissioningWorkOrder_Description | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetComponent->PlaceholderForAssetType_Description | string | |\r\n| linkedToAssetTypeId | PlaceholderAssetComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetComponent->LinkedToAssetType_Description | string | |\r\n| siteId | PlaceholderAssetComponent->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAssetComponent->Site_Code | string | |\r\n| siteDescription | PlaceholderAssetComponent->Site_Description | string | |\r\n| materialMasterId | PlaceholderAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetComponent->MaterialMaster_Description | string | |\r\n| developmentStatus | PlaceholderAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetComponent->IsInherited | boolean | |\r\n| inheritedFromId | PlaceholderAssetComponent->InheritedFrom_Id | integer | int64 |\r\n| isHistorical | PlaceholderAssetComponent->IsHistorical | boolean | |\r\n| parentComponentCode | PlaceholderAssetComponent->ParentComponent_Code | string | |\r\n| assetCode | PlaceholderAssetComponent->Asset_Code | string | |\r\n| assetTreePathItems | PlaceholderAssetComponent->Asset_TreePathItems | array | array |\r\n| rulesLastEvaluatedOn | PlaceholderAssetComponent->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | PlaceholderAssetComponent->RuleEvaluationPassed | boolean | |\r\n| notes | PlaceholderAssetComponent->Notes | string | |\r\n| createdOn | PlaceholderAssetComponent->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetComponent->ModifiedOn | string | date-time |\r\n| treePathItems | PlaceholderAssetComponent->TreePathItems | array | array |\r\n", "operationId": "GetPlaceholderAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Create a new Placeholder Asset 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| assetId | PlaceholderAssetComponent->Asset_Id | integer | int64 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| permissionTreeId | PlaceholderAssetComponent->PermissionTree_Id | integer | int64 |\r\n| siteId | PlaceholderAssetComponent->Site_Id | integer | int64 |\r\n| parentComponentId | PlaceholderAssetComponent->ParentComponent_Id | integer | int64 |\r\n| quantity | PlaceholderAssetComponent->Quantity | integer | int32 |\r\n| partNumber | PlaceholderAssetComponent->PartNumber | string | |\r\n| barcode | PlaceholderAssetComponent->Barcode | string | |\r\n| serialNumber | PlaceholderAssetComponent->SerialNumber | string | |\r\n| qRCode | PlaceholderAssetComponent->QRCode | string | |\r\n| rFId | PlaceholderAssetComponent->RFId | string | |\r\n| specification | PlaceholderAssetComponent->Specification | string | |\r\n| commissionedOn | PlaceholderAssetComponent->CommissionedOn | string | date |\r\n| supplierId | PlaceholderAssetComponent->Supplier_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetComponent->SupplierPartNumber | string | |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| assetImportanceId | PlaceholderAssetComponent->AssetImportance_Id | integer | int64 |\r\n| commissioningWorkOrderId | PlaceholderAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| notes | PlaceholderAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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| 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| siteId | System Generated | true | If no value specified |\r\n| siteId | Nullable | False | |\r\n| parentComponentId | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\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| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 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\r\n", "operationId": "CreatePlaceholderAssetComponent", "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/CreatePlaceholderAssetComponentResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Lookups/LookupAssetComponentPlaceholderParentComponent": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Placeholder Asset Component for the Placeholder Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| recordType | AssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetComponentPlaceholderParentComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/AssetComponentPlaceholderParentComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentAsset": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Asset for the Placeholder Asset 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 | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupPlaceholderAssetComponentAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetComponentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentCommissioningWorkOrder": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Work Order for the Placeholder Asset 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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentCommissioningWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Work Order collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentCommissioningWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentImportance": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Asset Importance for the Placeholder Asset 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": "LookupPlaceholderAssetComponentImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetComponentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentLinkedAssetType": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset 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": "LookupPlaceholderAssetComponentLinkedAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentLinkedAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentMaterialMaster": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Material Master for the Placeholder Asset 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": "LookupPlaceholderAssetComponentMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentsMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentRegularAssetType": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Regular Asset Type for the Placeholder Asset 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": "LookupPlaceholderAssetComponentRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentSite": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Site for the Placeholder Asset 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentsSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Lookups/LookupPlaceholderAssetComponentSupplier": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Lookup the Supplier for the Placeholder Asset 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": "LookupPlaceholderAssetComponentSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Component" ], "summary": "Get a collection of Placeholder Asset 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| ruleEvaluationFailedReason | PlaceholderAssetComponent->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | PlaceholderAssetComponent->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | PlaceholderAssetComponent->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | PlaceholderAssetComponent->Unsubscribed | boolean | |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| createdByUserId | PlaceholderAssetComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponent->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponent->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponent->PermissionTree_Description | string | |\r\n| assetId | PlaceholderAssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | PlaceholderAssetComponent->Asset_Code | string | |\r\n| assetDescription | PlaceholderAssetComponent->Asset_Description | string | |\r\n| assetRecordType | PlaceholderAssetComponent->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetAssetTypeId | PlaceholderAssetComponent->Asset_AssetType_Id | integer | int64 |\r\n| assetAssetTypeRecordType | PlaceholderAssetComponent->Asset_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetNearestRegularAssetId | PlaceholderAssetComponent->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetNearestRegularAssetCode | PlaceholderAssetComponent->Asset_NearestRegularAsset_Code | string | |\r\n| assetNearestRegularAssetDescription | PlaceholderAssetComponent->Asset_NearestRegularAsset_Description | string | |\r\n| assetTreePathId | PlaceholderAssetComponent->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | PlaceholderAssetComponent->Asset_TreePathItems | array | array |\r\n| developmentStatus | PlaceholderAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetComponent->Id | integer | int64 |\r\n| isActive | PlaceholderAssetComponent->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetComponent->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetComponent->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetComponent->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponent->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | PlaceholderAssetComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | PlaceholderAssetComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | PlaceholderAssetComponent->ParentComponent_Description | string | |\r\n| parentComponentTreePathId | PlaceholderAssetComponent->ParentComponent_TreePathId | integer | int64 |\r\n| parentComponentTreePathItems | PlaceholderAssetComponent->ParentComponent_TreePathItems | array | array |\r\n| recordType | PlaceholderAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| siteId | PlaceholderAssetComponent->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAssetComponent->Site_Code | string | |\r\n| siteDescription | PlaceholderAssetComponent->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponent->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetComponent->Unsynchronised | boolean | |\r\n| treePathId | PlaceholderAssetComponent->TreePathId | integer | int64 |\r\n| treePathItems | PlaceholderAssetComponent->TreePathItems | array | array |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| assetImportanceId | PlaceholderAssetComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | PlaceholderAssetComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | PlaceholderAssetComponent->AssetImportance_Description | string | |\r\n| assetTypeId | PlaceholderAssetComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | PlaceholderAssetComponent->AssetType_Code | string | |\r\n| assetTypeDescription | PlaceholderAssetComponent->AssetType_Description | string | |\r\n| assetTypeTreePathId | PlaceholderAssetComponent->AssetType_TreePathId | integer | int64 |\r\n| assetTypeTreePathItems | PlaceholderAssetComponent->AssetType_TreePathItems | array | array |\r\n| barcode | PlaceholderAssetComponent->Barcode | string | |\r\n| commissionedOn | PlaceholderAssetComponent->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | PlaceholderAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | PlaceholderAssetComponent->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | PlaceholderAssetComponent->CommissioningWorkOrder_Description | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| inheritedFromId | PlaceholderAssetComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAssetComponent->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromRulesLastChangedOn | PlaceholderAssetComponent->InheritedFrom_RulesLastChangedOn | string | date-time |\r\n| inheritedFromTreePathId | PlaceholderAssetComponent->InheritedFrom_TreePathId | integer | int64 |\r\n| inheritedFromTreePathItems | PlaceholderAssetComponent->InheritedFrom_TreePathItems | array | array |\r\n| linkedOnTypeSide | PlaceholderAssetComponent->LinkedOnTypeSide | boolean | |\r\n| linkedToAssetTypeId | PlaceholderAssetComponent->LinkedToAssetType_Id | integer | int64 |\r\n| linkedToAssetTypeCode | PlaceholderAssetComponent->LinkedToAssetType_Code | string | |\r\n| linkedToAssetTypeDescription | PlaceholderAssetComponent->LinkedToAssetType_Description | string | |\r\n| linkedToAssetTypeTreePathId | PlaceholderAssetComponent->LinkedToAssetType_TreePathId | integer | int64 |\r\n| linkedToAssetTypeTreePathItems | PlaceholderAssetComponent->LinkedToAssetType_TreePathItems | array | array |\r\n| materialMasterId | PlaceholderAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetComponent->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetComponent->Notes | string | |\r\n| partNumber | PlaceholderAssetComponent->PartNumber | string | |\r\n| placeholderForAssetTypeId | PlaceholderAssetComponent->PlaceholderForAssetType_Id | integer | int64 |\r\n| placeholderForAssetTypeCode | PlaceholderAssetComponent->PlaceholderForAssetType_Code | string | |\r\n| placeholderForAssetTypeDescription | PlaceholderAssetComponent->PlaceholderForAssetType_Description | string | |\r\n| placeholderForAssetTypeTreePathId | PlaceholderAssetComponent->PlaceholderForAssetType_TreePathId | integer | int64 |\r\n| placeholderForAssetTypeTreePathItems | PlaceholderAssetComponent->PlaceholderForAssetType_TreePathItems | array | array |\r\n| qRCode | PlaceholderAssetComponent->QRCode | string | |\r\n| quantity | PlaceholderAssetComponent->Quantity | integer | int32 |\r\n| rFId | PlaceholderAssetComponent->RFId | string | |\r\n| serialNumber | PlaceholderAssetComponent->SerialNumber | string | |\r\n| specification | PlaceholderAssetComponent->Specification | string | |\r\n| supplierId | PlaceholderAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetComponent->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetComponent->Supplier_Description | string | |\r\n| supplierPartNumber | PlaceholderAssetComponent->SupplierPartNumber | string | |\r\n| warranty | PlaceholderAssetComponent->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "BatchGetPlaceholderAssetComponent", "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 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 Component collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetComponentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Batch": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Create a new collection of Placeholder Asset 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| assetId | PlaceholderAssetComponent->Asset_Id | integer | int64 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| permissionTreeId | PlaceholderAssetComponent->PermissionTree_Id | integer | int64 |\r\n| siteId | PlaceholderAssetComponent->Site_Id | integer | int64 |\r\n| parentComponentId | PlaceholderAssetComponent->ParentComponent_Id | integer | int64 |\r\n| quantity | PlaceholderAssetComponent->Quantity | integer | int32 |\r\n| partNumber | PlaceholderAssetComponent->PartNumber | string | |\r\n| barcode | PlaceholderAssetComponent->Barcode | string | |\r\n| serialNumber | PlaceholderAssetComponent->SerialNumber | string | |\r\n| qRCode | PlaceholderAssetComponent->QRCode | string | |\r\n| rFId | PlaceholderAssetComponent->RFId | string | |\r\n| specification | PlaceholderAssetComponent->Specification | string | |\r\n| supplierId | PlaceholderAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetComponent->SupplierPartNumber | string | |\r\n| commissionedOn | PlaceholderAssetComponent->CommissionedOn | string | date |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| assetImportanceId | PlaceholderAssetComponent->AssetImportance_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| commissioningWorkOrderId | PlaceholderAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| notes | PlaceholderAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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| 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| siteId | System Generated | true | If no value specified |\r\n| siteId | Nullable | False | |\r\n| parentComponentId | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\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| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 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\r\n", "operationId": "BatchCreatePlaceholderAssetComponent", "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/BatchCreatePlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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 Component" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n| alternativeDescription | PlaceholderAssetComponent->AlternativeDescription | string | |\r\n| quantity | PlaceholderAssetComponent->Quantity | integer | int32 |\r\n| partNumber | PlaceholderAssetComponent->PartNumber | string | |\r\n| qRCode | PlaceholderAssetComponent->QRCode | string | |\r\n| rFId | PlaceholderAssetComponent->RFId | string | |\r\n| barcode | PlaceholderAssetComponent->Barcode | string | |\r\n| serialNumber | PlaceholderAssetComponent->SerialNumber | string | |\r\n| specification | PlaceholderAssetComponent->Specification | string | |\r\n| sequenceNumber | PlaceholderAssetComponent->SequenceNumber | integer | int32 |\r\n| commissionedOn | PlaceholderAssetComponent->CommissionedOn | string | date |\r\n| supplierId | PlaceholderAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | PlaceholderAssetComponent->SupplierPartNumber | string | |\r\n| assetImportanceId | PlaceholderAssetComponent->AssetImportance_Id | integer | int64 |\r\n| commissioningWorkOrderId | PlaceholderAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| notes | PlaceholderAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| code | Nullable | False | |\r\n| code | Read-only | True | PlaceholderAssetComponent->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 | PlaceholderAssetComponent->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| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 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| 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": "BatchUpdatePlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Component" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetComponent->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": "BatchDeletePlaceholderAssetComponent", "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/BatchDeletePlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component 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/PlaceholderAssetComponents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Accept the Development Status for an existing Placeholder Asset Component resource.", "description": "", "operationId": "AcceptPlaceholderAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Component resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Component resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Batch/{ids}/Sync": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Synchronise the collection of existing Placeholder Asset Component resource id's.", "description": "", "operationId": "BatchSyncPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetComponent->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponent->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": "ChangePlaceholderAssetComponentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssetComponents/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponent->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": "ChangePlaceholderAssetComponentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssetComponents/{id}/ClearPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Clear the Placeholder Asset 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 | ClearPlaceholderAssetComponentEntity->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": "ClearPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ClearPlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/LinkPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Link the Placeholder Asset 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 | LinkPlaceholderAssetComponentEntity->Version | integer | int32 |\r\n| linkedToAssetTypeId | LinkPlaceholderAssetComponentEntity->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": "LinkPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/LinkPlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Reject the Development Status for an existing Placeholder Asset Component resource.", "description": "", "operationId": "RejectPlaceholderAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Sync/Resubscribe": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Accept the Development Status for an existing Placeholder Asset 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| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "ResubscribePlaceholderAssetComponentDevelopmentStatus", "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/ResubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/SetPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Set the Regular Asset ComponentPlaceholder.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetPlaceholderAssetComponentEntity->Version | integer | int32 |\r\n| componentPlaceholderForAssetTypeId | SetPlaceholderAssetComponentEntity->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": "SetPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/SetPlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/Sync": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Synchronise the existing Placeholder Asset Component resource.", "description": "", "operationId": "SyncPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{id}/UnlinkPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Unlink the Placeholder Asset 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 | UnlinkPlaceholderAssetComponentEntity->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": "UnlinkPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UnlinkPlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Sync/Unsubscribe": { "post": { "tags": [ "Placeholder Asset Component" ], "summary": "Accept the Development Status for an existing Placeholder Asset 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| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "UnsubscribePlaceholderAssetComponentDevelopmentStatus", "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/UnsubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponent->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": "BatchChangePlaceholderAssetComponentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssetComponents/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponent->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": "BatchChangePlaceholderAssetComponentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/PlaceholderAssetComponents/Batch/ClearPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Clear the Placeholder Asset Component for a collection of existing Placeholder Asset 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 | ClearPlaceholderAssetComponentEntity->Id | integer | int64 |\r\n| version | ClearPlaceholderAssetComponentEntity->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": "BatchClearPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchClearPlaceholderAssetComponentResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Batch/LinkPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Link the Placeholder Asset Component for a collection of existing Placeholder Asset 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 | LinkPlaceholderAssetComponentEntity->Id | integer | int64 |\r\n| version | LinkPlaceholderAssetComponentEntity->Version | integer | int32 |\r\n| linkedToAssetTypeId | LinkPlaceholderAssetComponentEntity->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": "BatchLinkPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchLinkPlaceholderAssetComponentResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Batch/SetPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Set the Placeholder Asset Component for a collection of existing Placeholder Asset 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 | SetPlaceholderAssetComponentEntity->Id | integer | int64 |\r\n| version | SetPlaceholderAssetComponentEntity->Version | integer | int32 |\r\n| componentPlaceholderForAssetTypeId | SetPlaceholderAssetComponentEntity->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": "BatchSetPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchSetPlaceholderAssetComponentResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Batch/UnlinkPlaceholderAssetComponent": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Unlink the Placeholder Asset Component for a collection of existing Placeholder Asset 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 | UnlinkPlaceholderAssetComponentEntity->Id | integer | int64 |\r\n| version | UnlinkPlaceholderAssetComponentEntity->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": "BatchUnlinkPlaceholderAssetComponent", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUnlinkPlaceholderAssetComponentResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/MatchBatch": { "patch": { "tags": [ "Placeholder Asset Component" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| version | PlaceholderAssetComponent->Version | integer | int32 |\r\n| quantity | PlaceholderAssetComponent->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| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdatePlaceholderAssetComponent", "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/MatchUpdatePlaceholderAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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/PlaceholderAssetComponents/ActiveConditions/{id}": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Get a Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentActiveCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentActiveCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentActiveCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentActiveCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentActiveCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentActiveCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentActiveCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentActiveCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentActiveCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentActiveCondition->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetComponentActiveCondition->Id | integer | int64 |\r\n| conditionId | PlaceholderAssetComponentActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetComponentActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Description | string | |\r\n| notes | PlaceholderAssetComponentActiveCondition->Notes | string | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Description | string | |\r\n| placeholderAssetComponentAssetId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetCode | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetComponentAssetNearestRegularAssetDescription | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetComponentActiveCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Active Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Component Active Condition", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentActiveConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Update an existing Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentActiveCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetComponentActiveCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Active Condition was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Delete an existing Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->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": "DeletePlaceholderAssetComponentActiveCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Active Condition was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Get a collection of Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Description | string | |\r\n| conditionId | PlaceholderAssetComponentActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetComponentActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetComponentActiveConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component Active Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentActiveConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Create a new Placeholder Asset Component Active Condition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetComponentActiveCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetComponentActiveCondition->Condition_Id | integer | int64 |\r\n| notes | PlaceholderAssetComponentActiveCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | Nullable | False | |\r\n| placeholderAssetComponentId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetComponentActiveCondition", "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/CreatePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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/PlaceholderAssetComponents/{id}/ActiveConditions": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Get a collection of PlaceholderAssetComponentActiveCondition resources for the PlaceholderAssetComponent.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Description | string | |\r\n| conditionId | PlaceholderAssetComponentActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetComponentActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetComponentActiveConditionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Component Active Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentActiveConditionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Lookups/LookupPlaceholderAssetComponentActiveConditionChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Lookup the permission set for changing the Placeholder Asset Component Active 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": "LookupPlaceholderAssetComponentActiveConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentActiveConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Lookups/LookupPlaceholderAssetComponentActiveConditionCondition": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Lookup the Condition Type for the Placeholder Asset Component Active 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| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentActiveConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentActiveConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Lookups/LookupPlaceholderAssetComponentActiveConditionInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Lookup the permission set for creating the Placeholder Asset Component Active 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": "LookupPlaceholderAssetComponentActiveConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentActiveConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Lookups/LookupPlaceholderAssetComponentActiveConditionPlaceholderAssetComponent": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Lookup the Placeholder Asset Component for the Placeholder Asset Component Active 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentActiveConditionPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentActiveConditionPlaceholderAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Lookups/LookupPlaceholderAssetComponentActiveConditionRegularAsset": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Lookup the Regular Asset for the Placeholder Asset Component Active 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentActiveConditionRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentActiveConditionRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Get a collection of Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentActiveCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentActiveCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentActiveCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentActiveCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentActiveCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentActiveCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentActiveCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentActiveCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentActiveCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentActiveCondition->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetComponentActiveCondition->Id | integer | int64 |\r\n| conditionId | PlaceholderAssetComponentActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetComponentActiveCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Description | string | |\r\n| notes | PlaceholderAssetComponentActiveCondition->Notes | string | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Description | string | |\r\n| placeholderAssetComponentAssetId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetCode | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetComponentAssetNearestRegularAssetDescription | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPlaceholderAssetComponentActiveCondition", "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 Component Active 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 Component Active Condition collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetComponentActiveConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Batch": { "post": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Create a new collection of Placeholder Asset Component Active Condition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetComponentActiveCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| conditionId | PlaceholderAssetComponentActiveCondition->Condition_Id | integer | int64 |\r\n| notes | PlaceholderAssetComponentActiveCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | Nullable | False | |\r\n| placeholderAssetComponentId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetComponentActiveCondition", "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/BatchCreatePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Component Active 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 Component Active Condition" ], "summary": "Update a collection of existing Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| conditionId | PlaceholderAssetComponentActiveCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentActiveCondition->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentActiveCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| conditionId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetComponentActiveCondition", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Component Active Condition batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Delete a collection of existing Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentActiveCondition->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeletePlaceholderAssetComponentActiveCondition", "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/BatchDeletePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Active Condition batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentActiveCondition->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": "ChangePlaceholderAssetComponentActiveConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentActiveConditionPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/ActiveConditions/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Active Condition" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset Component Active 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 | PlaceholderAssetComponentActiveCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentActiveCondition->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": "BatchChangePlaceholderAssetComponentActiveConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentActiveConditionPermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Attributes/{id}": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Get a Placeholder Asset Component 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| inheritedFrom | PlaceholderAssetComponentAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeAttribute | PlaceholderAssetComponentAttribute->InheritedFromRegularAssetTypeAttribute | boolean | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Description | string | |\r\n| developmentStatus | PlaceholderAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | PlaceholderAssetComponentAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponentAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponentAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponentAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | PlaceholderAssetComponentAttribute->IsHistorical | boolean | |\r\n| unsynchronised | PlaceholderAssetComponentAttribute->Unsynchronised | boolean | |\r\n| isInherited | PlaceholderAssetComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n", "operationId": "GetPlaceholderAssetComponentAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Component Attribute", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetComponentAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->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": "DeletePlaceholderAssetComponentAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/{placeholderAssetComponentId}/Attributes": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Get a collection of Placeholder Asset Component Attribute resources for the Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetComponentAttribute->IsInherited | boolean | |\r\n| attributeId | PlaceholderAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetComponentAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetComponentAttributeCollectionForPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "placeholderAssetComponentId", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Component Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentAttributeCollectionForPlaceholderAssetComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetComponentAttribute->IsInherited | boolean | |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Description | string | |\r\n| attributeId | PlaceholderAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | PlaceholderAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n| createdOn | PlaceholderAssetComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetComponentAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetComponentAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component Attribute collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Create a new Placeholder Asset 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| placeholderAssetComponentId | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | 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": "CreatePlaceholderAssetComponentAttribute", "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/CreatePlaceholderAssetComponentAttributeResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Attributes/Lookups/LookupPlaceholderAssetComponentAttributeAllowedValue": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Placeholder Asset 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": "LookupPlaceholderAssetComponentAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Lookups/LookupPlaceholderAssetComponentAttribute": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Lookup the Attribute for the Placeholder Asset 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": "LookupPlaceholderAssetComponentAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Lookups/LookupPlaceholderAssetComponentAttributeInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetComponentAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Lookups/LookupPlaceholderAssetComponentAttributePlaceholderAssetComponent": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Lookup the Placeholder Asset Component Attribute for the Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentAttributePlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentAttributePlaceholderAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Lookups/LookupPlaceholderAssetComponentAttributeChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetComponentAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Get a collection of Placeholder Asset 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| inheritedFrom | PlaceholderAssetComponentAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeAttribute | PlaceholderAssetComponentAttribute->InheritedFromRegularAssetTypeAttribute | boolean | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Description | string | |\r\n| developmentStatus | PlaceholderAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | PlaceholderAssetComponentAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponentAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponentAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponentAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | PlaceholderAssetComponentAttribute->IsHistorical | boolean | |\r\n| unsynchronised | PlaceholderAssetComponentAttribute->Unsynchronised | boolean | |\r\n| isInherited | PlaceholderAssetComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | PlaceholderAssetComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | PlaceholderAssetComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | PlaceholderAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentAttribute->PermissionTree_Description | string | |\r\n| version | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| id | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| attributeId | PlaceholderAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | PlaceholderAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | PlaceholderAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | PlaceholderAssetComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | PlaceholderAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | PlaceholderAssetComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | PlaceholderAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | PlaceholderAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n", "operationId": "BatchGetPlaceholderAssetComponentAttribute", "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 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 Component Attribute collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetComponentAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Batch": { "post": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Create a new collection of Placeholder Asset 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| placeholderAssetComponentId | PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Id | integer | int64 |\r\n| attributeId | PlaceholderAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | 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": "BatchCreatePlaceholderAssetComponentAttribute", "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/BatchCreatePlaceholderAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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 Component Attribute" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| value | PlaceholderAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | PlaceholderAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdatePlaceholderAssetComponentAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentAttribute->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": "BatchDeletePlaceholderAssetComponentAttribute", "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/BatchDeletePlaceholderAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Accept the Development Status for an existing Placeholder Asset Component Attribute resource.", "description": "", "operationId": "AcceptPlaceholderAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Component Attribute resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Component Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Component Attribute resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Component Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentAttribute->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": "ChangePlaceholderAssetComponentAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentAttributeIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentAttribute->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": "ChangePlaceholderAssetComponentAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentAttributePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Reject the Development Status for an existing Placeholder Asset Component Attribute resource.", "description": "", "operationId": "RejectPlaceholderAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Attributes/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentAttribute->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": "BatchChangePlaceholderAssetComponentAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentAttributeIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentAttribute->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentAttribute->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": "BatchChangePlaceholderAssetComponentAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentAttributePermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Conditions/{id}": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Get a Placeholder Asset 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| developmentStatus | PlaceholderAssetComponentCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetComponentCondition->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetComponentCondition->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetComponentCondition->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetComponentCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponentCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponentCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetComponentCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponentCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetComponentCondition->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentCondition->PermissionTree_Description | string | |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetComponentCondition->Condition_Id | integer | int64 |\r\n| conditionAdjustmentFactor | PlaceholderAssetComponentCondition->Condition_AdjustmentFactor | number | decimal |\r\n| conditionCode | PlaceholderAssetComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetComponentCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFrom | PlaceholderAssetComponentCondition->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeCondition | PlaceholderAssetComponentCondition->InheritedFromRegularAssetTypeCondition | boolean | |\r\n| notes | PlaceholderAssetComponentCondition->Notes | string | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Description | string | |\r\n| placeholderAssetComponentIsActive | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_IsActive | boolean | |\r\n| placeholderAssetComponentAssetId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetCode | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetComponentAssetNearestRegularAssetDescription | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description | string | |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetPlaceholderAssetComponentCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Component Condition", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetComponentCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetComponentCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->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": "DeletePlaceholderAssetComponentCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetComponentConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Condition was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetCode | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetComponentAssetNearestRegularAssetDescription | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description | string | |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Description | string | |\r\n| conditionId | PlaceholderAssetComponentCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isActive | PlaceholderAssetComponentCondition->IsActive | boolean | |\r\n| developmentStatus | PlaceholderAssetComponentCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetComponentCondition->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetComponentConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Create a new Placeholder Asset 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| permissionTreeId | PlaceholderAssetComponentCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| inheritedFrom | PlaceholderAssetComponentCondition->InheritedFrom | integer | int64 |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetComponentCondition->Condition_Id | integer | int64 |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetComponentCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | Nullable | False | |\r\n| placeholderAssetComponentId | Min Value | > 0| |\r\n| inheritedFrom | Min Value | >= 0| |\r\n| adjustmentFactor | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetComponentCondition", "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/CreatePlaceholderAssetComponentConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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/PlaceholderAssetComponents/{id}/Conditions": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Get a collection of PlaceholderAssetComponentCondition resources for the PlaceholderAssetComponent.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Description | string | |\r\n| conditionId | PlaceholderAssetComponentCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentCondition->Condition_ConditionType_Description | string | |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isInherited | PlaceholderAssetComponentCondition->IsInherited | boolean | |\r\n| isActive | PlaceholderAssetComponentCondition->IsActive | boolean | |\r\n| developmentStatus | PlaceholderAssetComponentCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n", "operationId": "GetPlaceholderAssetComponentConditionForPlaceholderAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Component Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentConditionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Lookups/LookupPlaceholderAssetComponentConditionChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetComponentConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Lookups/LookupPlaceholderAssetComponentConditionCondition": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Lookup the Condition for the Placeholder Asset 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| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Lookups/LookupPlaceholderAssetComponentConditionInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetComponentConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Lookups/LookupPlaceholderAssetComponentConditionPlaceholderAssetComponent": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Lookup the Placeholder Asset Component for the Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentConditionPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentConditionPlaceholderAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Lookups/LookupPlaceholderAssetComponentConditionRegularAsset": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Lookup the Regular Asset for the Placeholder Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentConditionRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentConditionRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Get a collection of Placeholder Asset 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| developmentStatus | PlaceholderAssetComponentCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetComponentCondition->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetComponentCondition->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetComponentCondition->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetComponentCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponentCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponentCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetComponentCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponentCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetComponentCondition->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentCondition->PermissionTree_Description | string | |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetComponentCondition->Condition_Id | integer | int64 |\r\n| conditionAdjustmentFactor | PlaceholderAssetComponentCondition->Condition_AdjustmentFactor | number | decimal |\r\n| conditionCode | PlaceholderAssetComponentCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetComponentCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetComponentCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetComponentCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetComponentCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFrom | PlaceholderAssetComponentCondition->InheritedFrom | integer | int64 |\r\n| inheritedFromRegularAssetTypeCondition | PlaceholderAssetComponentCondition->InheritedFromRegularAssetTypeCondition | boolean | |\r\n| notes | PlaceholderAssetComponentCondition->Notes | string | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Description | string | |\r\n| placeholderAssetComponentIsActive | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_IsActive | boolean | |\r\n| placeholderAssetComponentAssetId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetComponentAssetNearestRegularAssetCode | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetComponentAssetNearestRegularAssetDescription | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description | string | |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetPlaceholderAssetComponentCondition", "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 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 Component Condition collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetComponentConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Batch": { "post": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Create a new collection of Placeholder Asset 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| permissionTreeId | PlaceholderAssetComponentCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id | integer | int64 |\r\n| inheritedFrom | PlaceholderAssetComponentCondition->InheritedFrom | integer | int64 |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetComponentCondition->Condition_Id | integer | int64 |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetComponentCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | Nullable | False | |\r\n| placeholderAssetComponentId | Min Value | > 0| |\r\n| inheritedFrom | Min Value | >= 0| |\r\n| adjustmentFactor | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetComponentCondition", "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/BatchCreatePlaceholderAssetComponentConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 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 Component Condition" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetComponentCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetComponentCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetComponentCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| adjustmentFactor | Nullable | False | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetComponentCondition", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetComponentConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 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" } } }, "delete": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentCondition->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeletePlaceholderAssetComponentCondition", "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/BatchDeletePlaceholderAssetComponentConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Condition batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Accept the Development Status for an existing Placeholder Asset Component Condition resource.", "description": "", "operationId": "AcceptPlaceholderAssetComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Component Condition resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Component Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Component Condition resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Component Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentCondition->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": "ChangePlaceholderAssetComponentConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentConditionIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentCondition->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": "ChangePlaceholderAssetComponentConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentConditionPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Reject the Development Status for an existing Placeholder Asset Component Condition resource.", "description": "", "operationId": "RejectPlaceholderAssetComponentConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Conditions/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentCondition->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": "BatchChangePlaceholderAssetComponentConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentConditionIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Condition" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentCondition->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": "BatchChangePlaceholderAssetComponentConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentConditionPermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Documents/{id}": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Get a collection of Placeholder Asset Component Document resources for the Placeholder Asset 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 | PlaceholderAssetComponentDocument->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeDocument | PlaceholderAssetComponentDocument->InheritedFromRegularAssetTypeDocument | boolean | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Description | string | |\r\n| developmentStatus | PlaceholderAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | PlaceholderAssetComponentDocument->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetComponentDocument->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetComponentDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponentDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponentDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponentDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetComponentDocument->Unsynchronised | boolean | |\r\n| isActive | PlaceholderAssetComponentDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetComponentDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Component Document", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetComponentDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->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": "DeletePlaceholderAssetComponentDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component 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/PlaceholderAssetComponents/{id}/Documents": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Get a collection of Placeholder Asset Component Document resources for the Placeholder Asset 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 | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetComponentDocument->IsInherited | boolean | |\r\n| inheritedFromId | PlaceholderAssetComponentDocument->InheritedFrom_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n| createdOn | PlaceholderAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetComponentDocumentCollectionForPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Component Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentDocumentCollectionForPlaceholderAssetComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetComponentDocument->IsInherited | boolean | |\r\n| documentRecordId | PlaceholderAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n| createdOn | PlaceholderAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetComponentDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Create a new Placeholder Asset 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| placeholderAssetComponentId | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | 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": "CreatePlaceholderAssetComponentDocument", "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/CreatePlaceholderAssetComponentDocumentResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Documents/Lookups/LookupPlaceholderAssetComponentDocumentChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetComponentDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Lookups/LookupPlaceholderAssetComponentDocument": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Lookup the for the Placeholder Asset 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": "LookupPlaceholderAssetComponentDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Lookups/LookupPlaceholderAssetComponentDocumentInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetComponentDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Lookups/LookupPlaceholderAssetComponentDocumentPlaceholderAssetComponent": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Lookup the Placeholder Asset Component Document for the Placeholder Asset 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 | PlaceholderAssetComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentDocumentPlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentDocumentPlaceholderAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Get a collection of Placeholder Asset 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| inheritedFromId | PlaceholderAssetComponentDocument->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeDocument | PlaceholderAssetComponentDocument->InheritedFromRegularAssetTypeDocument | boolean | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Description | string | |\r\n| developmentStatus | PlaceholderAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | PlaceholderAssetComponentDocument->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetComponentDocument->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetComponentDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetComponentDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetComponentDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetComponentDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetComponentDocument->Unsynchronised | boolean | |\r\n| isActive | PlaceholderAssetComponentDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPlaceholderAssetComponentDocument", "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 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 Component Document collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetComponentDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Batch": { "post": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Create a new collection of Placeholder Asset 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| placeholderAssetComponentId | PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | 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": "BatchCreatePlaceholderAssetComponentDocument", "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/BatchCreatePlaceholderAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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 Component Document" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdatePlaceholderAssetComponentDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentDocument->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": "BatchDeletePlaceholderAssetComponentDocument", "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/BatchDeletePlaceholderAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component 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/PlaceholderAssetComponents/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Accept the Development Status for an existing Placeholder Asset Component Document resource.", "description": "", "operationId": "AcceptPlaceholderAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Component Document resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Component Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Component Document resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Component Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentDocument->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": "ChangePlaceholderAssetComponentDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentDocumentIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentDocument->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": "ChangePlaceholderAssetComponentDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentDocumentPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Reject the Development Status for an existing Placeholder Asset Component Document resource.", "description": "", "operationId": "RejectPlaceholderAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/Documents/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentDocument->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": "BatchChangePlaceholderAssetComponentDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentDocumentIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Component Document" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetComponentDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentDocument->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": "BatchChangePlaceholderAssetComponentDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentDocumentPermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/OptionValues/{id}": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Get a Placeholder Asset Component Option Value resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentOptionValue->Id | integer | int64 |\r\n| isCustom | PlaceholderAssetComponentOptionValue->IsCustom | boolean | |\r\n| optionId | PlaceholderAssetComponentOptionValue->Option_Id | integer | int64 |\r\n| optionAllowMultipleValues | PlaceholderAssetComponentOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionCode | PlaceholderAssetComponentOptionValue->Option_Code | string | |\r\n| optionDataType | PlaceholderAssetComponentOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionDescription | PlaceholderAssetComponentOptionValue->Option_Description | string | |\r\n| optionLowerBounds | PlaceholderAssetComponentOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | PlaceholderAssetComponentOptionValue->Option_UpperBounds | string | |\r\n| optionOptionCategoryId | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| regularAssetTypeOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| regularAssetTypeOptionOptionAllowMultipleValues | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_AllowMultipleValues | boolean | |\r\n| regularAssetTypeOptionOptionLowerBounds | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_LowerBounds | string | |\r\n| regularAssetTypeOptionOptionDataType | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| regularAssetTypeOptionOptionUpperBounds | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UpperBounds | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionOptionCategoryCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Code | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Description | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Code | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | PlaceholderAssetComponentOptionValue->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentOptionValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentOptionValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentOptionValue->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentOptionValue->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentOptionValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentOptionValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentOptionValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentOptionValue->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentOptionValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentOptionValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentOptionValue->PermissionTree_Description | string | |\r\n| notes | PlaceholderAssetComponentOptionValue->Notes | string | |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Description | string | |\r\n", "operationId": "GetPlaceholderAssetComponentOptionValue", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Option Value Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Component Option Value", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentOptionValueResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Update an existing Placeholder Asset Component Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| notes | PlaceholderAssetComponentOptionValue->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetComponentOptionValue", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Option Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Option Value was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Delete an existing Placeholder Asset Component Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetComponentOptionValue->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": "DeletePlaceholderAssetComponentOptionValue", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Option Value Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetComponentOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Option Value was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Get a collection of Placeholder Asset Component Option Value resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentOptionValue->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | PlaceholderAssetComponentOptionValue->IsActive | boolean | |\r\n| notes | PlaceholderAssetComponentOptionValue->Notes | string | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Description | string | |\r\n| regularAssetTypeOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| isCustom | PlaceholderAssetComponentOptionValue->IsCustom | boolean | |\r\n| optionId | PlaceholderAssetComponentOptionValue->Option_Id | integer | int64 |\r\n| optionCode | PlaceholderAssetComponentOptionValue->Option_Code | string | |\r\n| optionDescription | PlaceholderAssetComponentOptionValue->Option_Description | string | |\r\n| optionDataType | PlaceholderAssetComponentOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionLowerBounds | PlaceholderAssetComponentOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | PlaceholderAssetComponentOptionValue->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | PlaceholderAssetComponentOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionOptionCategoryCode | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementCode | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| createdOn | PlaceholderAssetComponentOptionValue->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetComponentOptionValue->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetComponentOptionValueCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component Option Value collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentOptionValueCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Create a new Placeholder Asset Component Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetComponentOptionValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id | integer | int64 |\r\n| regularAssetTypeOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| optionId | PlaceholderAssetComponentOptionValue->Option_Id | integer | int64 |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| notes | PlaceholderAssetComponentOptionValue->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | Nullable | False | |\r\n| placeholderAssetComponentId | Min Value | > 0| |\r\n| regularAssetTypeOptionId | Min Value | > 0| |\r\n| optionId | Nullable | False | |\r\n| optionValue | Required | True | |\r\n| optionValue | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetComponentOptionValue", "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/CreatePlaceholderAssetComponentOptionValueResourceActionRequest" } }, { "$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/PlaceholderAssetComponents/{id}/OptionValues": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Get a collection of PlaceholderAssetComponentOptionValue resources for the PlaceholderAssetComponent.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentOptionValue->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | PlaceholderAssetComponentOptionValue->IsActive | boolean | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Description | string | |\r\n| regularAssetTypeOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| optionId | PlaceholderAssetComponentOptionValue->Option_Id | integer | int64 |\r\n| optionOptionCategoryCode | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementCode | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| optionDataType | PlaceholderAssetComponentOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionLowerBounds | PlaceholderAssetComponentOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | PlaceholderAssetComponentOptionValue->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | PlaceholderAssetComponentOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionCode | PlaceholderAssetComponentOptionValue->Option_Code | string | |\r\n| optionDescription | PlaceholderAssetComponentOptionValue->Option_Description | string | |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| isCustom | PlaceholderAssetComponentOptionValue->IsCustom | boolean | |\r\n| createdOn | PlaceholderAssetComponentOptionValue->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetComponentOptionValue->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetComponentOptionValueForPlaceholderAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Component Option Value collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetComponentOptionValueForPlaceholderAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Lookups/LookupPlaceholderAssetComponentOptionValueChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Lookup the permission set for changing the Placeholder Asset Component Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetComponentOptionValueChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentOptionValueChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Lookups/LookupPlaceholderAssetComponentOptionValueInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Lookup the permission set for creating the Placeholder Asset Component Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetComponentOptionValueInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentOptionValueInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Lookups/LookupPlaceholderAssetComponentOptionValueOption": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Lookup the Regular Asset Type Option for the Placeholder Asset Component Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Option->Id | integer | int64 |\r\n| code | Option->Code | string | |\r\n| description | Option->Description | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Option->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Option->UnitOfMeasurement_Description | string | |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| optionCategoryCode | Option->OptionCategory_Code | string | |\r\n| optionCategoryDescription | Option->OptionCategory_Description | string | |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n", "operationId": "LookupPlaceholderAssetComponentOptionValueOption", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Option collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentOptionValueOptionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Lookups/LookupPlaceholderAssetComponentOptionValuePlaceholderAssetComponent": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Lookup the Placeholder Asset Component for the Placeholder Asset Component Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponent->Id | integer | int64 |\r\n| code | PlaceholderAssetComponent->Code | string | |\r\n| description | PlaceholderAssetComponent->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetComponentOptionValuePlaceholderAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Component collection", "schema": { "$ref": "#/definitions/PlaceholderAssetComponentOptionValuePlaceholderAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Lookups/LookupPlaceholderAssetComponentOptionValueRegularAssetTypeOptionForLinkedAssetType": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Lookup the Regular Asset Type Option for the Placeholder Asset Component Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeOption->Id | integer | int64 |\r\n| optionId | RegularAssetTypeOption->Option_Id | integer | int64 |\r\n| optionCode | RegularAssetTypeOption->Option_Code | string | |\r\n| optionDescription | RegularAssetTypeOption->Option_Description | string | |\r\n| optionUpperBounds | RegularAssetTypeOption->Option_UpperBounds | string | |\r\n| optionLowerBounds | RegularAssetTypeOption->Option_LowerBounds | string | |\r\n| optionDataType | RegularAssetTypeOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\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| 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| optionAllowMultipleValues | RegularAssetTypeOption->Option_AllowMultipleValues | boolean | |\r\n", "operationId": "LookupPlaceholderAssetComponentOptionValueRegularAssetTypeOptionForLinkedAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetComponentOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Get a collection of Placeholder Asset Component Option Value resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentOptionValue->Id | integer | int64 |\r\n| isCustom | PlaceholderAssetComponentOptionValue->IsCustom | boolean | |\r\n| optionId | PlaceholderAssetComponentOptionValue->Option_Id | integer | int64 |\r\n| optionAllowMultipleValues | PlaceholderAssetComponentOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionCode | PlaceholderAssetComponentOptionValue->Option_Code | string | |\r\n| optionDataType | PlaceholderAssetComponentOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionDescription | PlaceholderAssetComponentOptionValue->Option_Description | string | |\r\n| optionLowerBounds | PlaceholderAssetComponentOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | PlaceholderAssetComponentOptionValue->Option_UpperBounds | string | |\r\n| optionOptionCategoryId | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | PlaceholderAssetComponentOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| regularAssetTypeOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| regularAssetTypeOptionOptionAllowMultipleValues | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_AllowMultipleValues | boolean | |\r\n| regularAssetTypeOptionOptionLowerBounds | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_LowerBounds | string | |\r\n| regularAssetTypeOptionOptionDataType | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| regularAssetTypeOptionOptionUpperBounds | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UpperBounds | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionOptionCategoryCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Code | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Description | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementCode | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Code | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementDescription | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Description | string | |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | PlaceholderAssetComponentOptionValue->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetComponentOptionValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetComponentOptionValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetComponentOptionValue->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetComponentOptionValue->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetComponentOptionValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetComponentOptionValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetComponentOptionValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetComponentOptionValue->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetComponentOptionValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetComponentOptionValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetComponentOptionValue->PermissionTree_Description | string | |\r\n| notes | PlaceholderAssetComponentOptionValue->Notes | string | |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id | integer | int64 |\r\n| placeholderAssetComponentCode | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Code | string | |\r\n| placeholderAssetComponentDescription | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Description | string | |\r\n", "operationId": "BatchGetPlaceholderAssetComponentOptionValue", "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 Component Option Value id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Component Option Value collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetComponentOptionValueResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Batch": { "post": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Create a new collection of Placeholder Asset Component Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetComponentOptionValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| placeholderAssetComponentId | PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id | integer | int64 |\r\n| regularAssetTypeOptionId | PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| optionId | PlaceholderAssetComponentOptionValue->Option_Id | integer | int64 |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| notes | PlaceholderAssetComponentOptionValue->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetComponentId | Required | True | |\r\n| placeholderAssetComponentId | Nullable | False | |\r\n| placeholderAssetComponentId | Min Value | > 0| |\r\n| regularAssetTypeOptionId | Min Value | > 0| |\r\n| optionId | Nullable | False | |\r\n| optionValue | Required | True | |\r\n| optionValue | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetComponentOptionValue", "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/BatchCreatePlaceholderAssetComponentOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Option Value batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Update a collection of existing Placeholder Asset Component Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentOptionValue->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetComponentOptionValue->SequenceNumber | integer | int32 |\r\n| optionValue | PlaceholderAssetComponentOptionValue->OptionValue | string | |\r\n| notes | PlaceholderAssetComponentOptionValue->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdatePlaceholderAssetComponentOptionValue", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetComponentOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Option Value batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Delete a collection of existing Placeholder Asset Component Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentOptionValue->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentOptionValue->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": "BatchDeletePlaceholderAssetComponentOptionValue", "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/BatchDeletePlaceholderAssetComponentOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Component Option Value batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Change the IsActive status for an existing Placeholder Asset Component Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentOptionValue->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": "ChangePlaceholderAssetComponentOptionValueIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Component Option Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetComponentOptionValueIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssetComponents/OptionValues/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Component Option Value" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Component Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetComponentOptionValue->Id | integer | int64 |\r\n| version | PlaceholderAssetComponentOptionValue->Version | integer | int32 |\r\n| isActive | PlaceholderAssetComponentOptionValue->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": "BatchChangePlaceholderAssetComponentOptionValueIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetComponentOptionValueIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Conditions/{id}": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Get a Placeholder Asset 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| developmentStatus | PlaceholderAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetCondition->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetCondition->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetCondition->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetCondition->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetCondition->PermissionTree_Description | string | |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | PlaceholderAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAssetCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromConditionId | PlaceholderAssetCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | PlaceholderAssetCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | PlaceholderAssetCondition->InheritedFrom_Condition_Description | string | |\r\n| inheritedFromConditionConditionTypeId | PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Id | integer | int64 |\r\n| inheritedFromConditionConditionTypeCode | PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Code | string | |\r\n| inheritedFromConditionConditionTypeDescription | PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Description | string | |\r\n| notes | PlaceholderAssetCondition->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetCondition->PlaceholderAsset_Description | string | |\r\n| placeholderAssetNearestRegularAssetId | PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetNearestRegularAssetCode | PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetNearestRegularAssetDescription | PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Description | string | |\r\n| recordType | PlaceholderAssetCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetPlaceholderAssetCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Condition", "schema": { "$ref": "#/definitions/GetPlaceholderAssetConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Condition" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Condition was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Condition" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetCondition->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": "DeletePlaceholderAssetCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Condition was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetCondition->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetCondition->PlaceholderAsset_Description | string | |\r\n| conditionId | PlaceholderAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | PlaceholderAssetCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isActive | PlaceholderAssetCondition->IsActive | boolean | |\r\n| developmentStatus | PlaceholderAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetCondition->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Condition" ], "summary": "Create a new Placeholder Asset Condition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetCondition->PlaceholderAsset_Id | integer | int64 |\r\n| inheritedFromId | PlaceholderAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetCondition->Condition_Id | integer | int64 |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | Min Value | > 0| |\r\n| inheritedFromId | Min Value | >= 0| |\r\n| adjustmentFactor | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetCondition", "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/CreatePlaceholderAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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/PlaceholderAssets/{id}/Conditions": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Get a collection of PlaceholderAssetCondition resources for the PlaceholderAsset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetCondition->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetCondition->PlaceholderAsset_Description | string | |\r\n| conditionId | PlaceholderAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | PlaceholderAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetCondition->Condition_ConditionType_Description | string | |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isInherited | PlaceholderAssetCondition->IsInherited | boolean | |\r\n| isActive | PlaceholderAssetCondition->IsActive | boolean | |\r\n| developmentStatus | PlaceholderAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n", "operationId": "GetPlaceholderAssetConditionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Condition collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetConditionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Lookups/LookupPlaceholderAssetConditionChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Lookups/LookupPlaceholderAssetConditionCondition": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Lookup the Condition Type for the Placeholder Asset 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| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Lookups/LookupPlaceholderAssetConditionInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Lookups/LookupPlaceholderAssetConditionPlaceholderAsset": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Lookup the Placeholder Asset for the Placeholder Asset 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 | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConditionPlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConditionPlaceholderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Lookups/LookupPlaceholderAssetConditionRegularAsset": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Lookup the Regular Asset for the Placeholder Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConditionRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConditionRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Condition" ], "summary": "Get a collection of Placeholder Asset 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| developmentStatus | PlaceholderAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetCondition->Id | integer | int64 |\r\n| isActive | PlaceholderAssetCondition->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetCondition->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetCondition->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetCondition->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetCondition->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetCondition->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetCondition->PermissionTree_Description | string | |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | PlaceholderAssetCondition->Condition_Code | string | |\r\n| conditionDescription | PlaceholderAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | PlaceholderAssetCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | PlaceholderAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | PlaceholderAssetCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | PlaceholderAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAssetCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromConditionId | PlaceholderAssetCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | PlaceholderAssetCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | PlaceholderAssetCondition->InheritedFrom_Condition_Description | string | |\r\n| inheritedFromConditionConditionTypeId | PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Id | integer | int64 |\r\n| inheritedFromConditionConditionTypeCode | PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Code | string | |\r\n| inheritedFromConditionConditionTypeDescription | PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Description | string | |\r\n| notes | PlaceholderAssetCondition->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetCondition->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetCondition->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetCondition->PlaceholderAsset_Description | string | |\r\n| placeholderAssetNearestRegularAssetId | PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Id | integer | int64 |\r\n| placeholderAssetNearestRegularAssetCode | PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Code | string | |\r\n| placeholderAssetNearestRegularAssetDescription | PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Description | string | |\r\n| recordType | PlaceholderAssetCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetPlaceholderAssetCondition", "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 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 Condition collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Batch": { "post": { "tags": [ "Placeholder Asset Condition" ], "summary": "Create a new collection of Placeholder Asset Condition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetCondition->SequenceNumber | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetCondition->PlaceholderAsset_Id | integer | int64 |\r\n| inheritedFromId | PlaceholderAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | PlaceholderAssetCondition->Condition_Id | integer | int64 |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetCondition->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | Min Value | > 0| |\r\n| inheritedFromId | Min Value | >= 0| |\r\n| adjustmentFactor | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetCondition", "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/BatchCreatePlaceholderAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 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 Condition" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetCondition->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | PlaceholderAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | PlaceholderAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | PlaceholderAssetCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| adjustmentFactor | Nullable | False | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetCondition", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Condition batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Condition" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetCondition->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeletePlaceholderAssetCondition", "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/BatchDeletePlaceholderAssetConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Condition batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Condition" ], "summary": "Accept the Development Status for an existing Placeholder Asset Condition resource.", "description": "", "operationId": "AcceptPlaceholderAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Condition" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Condition resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Condition" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Condition resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Condition" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetCondition->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": "ChangePlaceholderAssetConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetConditionIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Condition" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetCondition->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": "ChangePlaceholderAssetConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetConditionPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Condition" ], "summary": "Reject the Development Status for an existing Placeholder Asset Condition resource.", "description": "", "operationId": "RejectPlaceholderAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Conditions/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Condition" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetCondition->Version | integer | int32 |\r\n| isActive | PlaceholderAssetCondition->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": "BatchChangePlaceholderAssetConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetConditionIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Condition" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetCondition->Id | integer | int64 |\r\n| version | PlaceholderAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetCondition->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": "BatchChangePlaceholderAssetConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetConditionPermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssets/Consumption/{id}": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Get a Placeholder Asset Consumption 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| placeholderAssetId | PlaceholderAssetConsumption->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetConsumption->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetConsumption->PlaceholderAsset_Description | string | |\r\n| isActive | PlaceholderAssetConsumption->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetConsumption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetConsumption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetConsumption->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetConsumption->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetConsumption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetConsumption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetConsumption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetConsumption->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetConsumption->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetConsumption->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetConsumption->Id | integer | int64 |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | PlaceholderAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | PlaceholderAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | PlaceholderAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | PlaceholderAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | PlaceholderAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | PlaceholderAssetConsumption->CostElement_Description | string | |\r\n| currencyId | PlaceholderAssetConsumption->Currency_Id | integer | int64 |\r\n| currencyCode | PlaceholderAssetConsumption->Currency_Code | string | |\r\n| currencyDescription | PlaceholderAssetConsumption->Currency_Description | string | |\r\n| currencyRateId | PlaceholderAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateUserSuppliedConversionRate | PlaceholderAssetConsumption->CurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| currencyRateAppliedConversionRate | PlaceholderAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | PlaceholderAssetConsumption->CurrencyRateValue | number | decimal |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | PlaceholderAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | PlaceholderAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | PlaceholderAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | PlaceholderAssetConsumption->GeneralLedger_Description | string | |\r\n| locationId | PlaceholderAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | PlaceholderAssetConsumption->Location_Code | string | |\r\n| locationDescription | PlaceholderAssetConsumption->Location_Description | string | |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetConsumption->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetConsumption->Meter_Description | string | |\r\n| meterUnitOfMeasurementId | PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Id | integer | int64 |\r\n| meterUnitOfMeasurementCode | PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Code | string | |\r\n| meterUnitOfMeasurementDescription | PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Description | string | |\r\n| meterReadingId | PlaceholderAssetConsumption->MeterReading_Id | integer | int64 |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| notes | PlaceholderAssetConsumption->Notes | string | |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | PlaceholderAssetConsumption->Resource_Description | string | |\r\n| siteId | PlaceholderAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAssetConsumption->Site_Code | string | |\r\n| siteDescription | PlaceholderAssetConsumption->Site_Description | string | |\r\n| siteCurrencyId | PlaceholderAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | PlaceholderAssetConsumption->SiteCurrency_Code | string | |\r\n| siteCurrencyDescription | PlaceholderAssetConsumption->SiteCurrency_Description | string | |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | PlaceholderAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | PlaceholderAssetConsumption->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | PlaceholderAssetConsumption->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | PlaceholderAssetConsumption->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | PlaceholderAssetConsumption->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | PlaceholderAssetConsumption->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | PlaceholderAssetConsumption->StockItem_Warehouse_Description | string | |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetConsumption->Supplier_Description | string | |\r\n| totalCost | PlaceholderAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | PlaceholderAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | PlaceholderAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | PlaceholderAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n", "operationId": "GetPlaceholderAssetConsumption", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Consumption Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Consumption", "schema": { "$ref": "#/definitions/GetPlaceholderAssetConsumptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Update an existing Placeholder Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | PlaceholderAssetConsumption->Currency_Id | integer | int64 |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | PlaceholderAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | Nullable | False | |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetConsumption", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Consumption was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-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": [ "Placeholder Asset Consumption" ], "summary": "Delete an existing Placeholder Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetConsumption->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": "DeletePlaceholderAssetConsumption", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Consumption 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/PlaceholderAssets/Consumption/{assetConsumptionId}/Costing": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Get a collection of Costing resources for the Placeholder Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Costing->Id | integer | int64 |\r\n| description | Costing->Description | string | |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n", "operationId": "GetCostingForPlaceholderAssetConsumptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "assetConsumptionId", "in": "path", "required": true, "description": "Asset Consumption 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 Consumption collection", "schema": { "$ref": "#/definitions/GetCostingCollectionForPlaceholderAssetConsumptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Get a collection of Placeholder Asset Consumption 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 | PlaceholderAssetConsumption->Id | integer | int64 |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetConsumption->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetConsumption->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetConsumption->PlaceholderAsset_Description | string | |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | PlaceholderAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | PlaceholderAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | PlaceholderAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | PlaceholderAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | PlaceholderAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | PlaceholderAssetConsumption->GeneralLedger_Description | string | |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | PlaceholderAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | PlaceholderAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | PlaceholderAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | PlaceholderAssetConsumption->CostElement_Description | string | |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | PlaceholderAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | PlaceholderAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | PlaceholderAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| locationId | PlaceholderAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | PlaceholderAssetConsumption->Location_Code | string | |\r\n| locationDescription | PlaceholderAssetConsumption->Location_Description | string | |\r\n| siteId | PlaceholderAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAssetConsumption->Site_Code | string | |\r\n| siteDescription | PlaceholderAssetConsumption->Site_Description | string | |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetConsumption->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetConsumption->Meter_Description | string | |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetConsumption->Supplier_Description | string | |\r\n| siteCurrencyId | PlaceholderAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | PlaceholderAssetConsumption->SiteCurrency_Code | string | |\r\n| currencyRateId | PlaceholderAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | PlaceholderAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n| totalCost | PlaceholderAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | PlaceholderAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | PlaceholderAssetConsumption->Resource_Description | string | |\r\n", "operationId": "GetPlaceholderAssetConsumptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Consumption collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetConsumptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Create a new Placeholder Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetId | PlaceholderAssetConsumption->PlaceholderAsset_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | PlaceholderAssetConsumption->Currency_Id | integer | int64 |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | PlaceholderAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| consumableId | Required | True | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | System Generated | true | If no value specified |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| unitPrice | System Generated | true | If no value specified |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetConsumption", "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/CreatePlaceholderAssetConsumptionResourceActionRequest" } }, { "$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/PlaceholderAssets/{id}/Consumption": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Get a collection of PlaceholderAssetConsumption resources for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetConsumption->Id | integer | int64 |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetConsumption->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetConsumption->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetConsumption->PlaceholderAsset_Description | string | |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | PlaceholderAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | PlaceholderAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | PlaceholderAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | PlaceholderAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | PlaceholderAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | PlaceholderAssetConsumption->GeneralLedger_Description | string | |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | PlaceholderAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | PlaceholderAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | PlaceholderAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | PlaceholderAssetConsumption->CostElement_Description | string | |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | PlaceholderAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | PlaceholderAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | PlaceholderAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| locationId | PlaceholderAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | PlaceholderAssetConsumption->Location_Code | string | |\r\n| locationDescription | PlaceholderAssetConsumption->Location_Description | string | |\r\n| siteId | PlaceholderAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAssetConsumption->Site_Code | string | |\r\n| siteDescription | PlaceholderAssetConsumption->Site_Description | string | |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetConsumption->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetConsumption->Meter_Description | string | |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetConsumption->Supplier_Description | string | |\r\n| siteCurrencyId | PlaceholderAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | PlaceholderAssetConsumption->SiteCurrency_Code | string | |\r\n| currencyRateId | PlaceholderAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | PlaceholderAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n| totalCost | PlaceholderAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | PlaceholderAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | PlaceholderAssetConsumption->Resource_Description | string | |\r\n", "operationId": "GetPlaceholderAssetConsumptionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Consumption collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetConsumptionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup the permission set for changing the Placeholder Asset Consumption.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetConsumptionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConsumptionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionConsumable": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup the Consumable for the Placeholder Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Consumable->Id | integer | int64 |\r\n| code | Consumable->Code | string | |\r\n| description | Consumable->Description | string | |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Consumable->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Consumable->UnitOfMeasurement_Description | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| currencyCode | Consumable->Currency_Code | string | |\r\n| currencyDescription | Consumable->Currency_Description | string | |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\r\n", "operationId": "LookupPlaceholderAssetConsumptionConsumable", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Consumable collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionConsumableLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionCostCentre": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Cost Centre for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionCostElement": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Cost Element for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetConsumptionCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConsumptionCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionFinancialYearPeriod": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Financial Year Period for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionFinancialYearPeriod", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year Period collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionGeneralLedger": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup General Ledger for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup the permission set for creating the Placeholder Asset Consumption.", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetConsumptionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConsumptionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionMeter": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Meter for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Meter->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Meter->UnitOfMeasurement_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionPlaceholderAsset": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup the Placeholder Asset for the Placeholder Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| siteId | PlaceholderAsset->Site_Id | integer | int64 |\r\n| siteFinancialYearPeriodId | PlaceholderAsset->Site_FinancialYearPeriod_Id | integer | int64 |\r\n| siteFinancialYearPeriodCode | PlaceholderAsset->Site_FinancialYearPeriod_Code | string | |\r\n| siteFinancialYearPeriodDescription | PlaceholderAsset->Site_FinancialYearPeriod_Description | string | |\r\n| siteCurrencyId | PlaceholderAsset->Site_Currency_Id | integer | int64 |\r\n| siteCurrencyCode | PlaceholderAsset->Site_Currency_Code | string | |\r\n| siteCurrencyDescription | PlaceholderAsset->Site_Currency_Description | string | |\r\n| siteCode | PlaceholderAsset->Site_Code | string | |\r\n| siteDescription | PlaceholderAsset->Site_Description | string | |\r\n| costCentreId | PlaceholderAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | PlaceholderAsset->CostCentre_Code | string | |\r\n| costCentreDescription | PlaceholderAsset->CostCentre_Description | string | |\r\n| generalLedgerId | PlaceholderAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | PlaceholderAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | PlaceholderAsset->GeneralLedger_Description | string | |\r\n| locationId | PlaceholderAsset->Location_Id | integer | int64 |\r\n| locationCode | PlaceholderAsset->Location_Code | string | |\r\n| locationDescription | PlaceholderAsset->Location_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionPlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionPlaceholderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionResource": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Resource for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\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": "LookupPlaceholderAssetConsumptionResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConsumptionResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionStockItem": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Stock Item for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionStockItem", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Stock Item collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionSupplier": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Supplier for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n| siteCurrencyId | Supplier->Site_Currency_Id | integer | int64 |\r\n| siteCurrencyCode | Supplier->Site_Currency_Code | string | |\r\n| siteCurrencyDescription | Supplier->Site_Currency_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConsumptionSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionUnitOfMeasurement": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Unit Of Measurement for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetConsumptionUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Lookups/LookupPlaceholderAssetConsumptionCurrency": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Lookup Currency for the Placeholder Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetConsumptionCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/PlaceholderAssetConsumptionCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Get a collection of Placeholder Asset Consumption 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| placeholderAssetId | PlaceholderAssetConsumption->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetConsumption->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetConsumption->PlaceholderAsset_Description | string | |\r\n| isActive | PlaceholderAssetConsumption->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetConsumption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetConsumption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetConsumption->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetConsumption->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetConsumption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetConsumption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetConsumption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetConsumption->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetConsumption->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetConsumption->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetConsumption->Id | integer | int64 |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | PlaceholderAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | PlaceholderAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | PlaceholderAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | PlaceholderAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | PlaceholderAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | PlaceholderAssetConsumption->CostElement_Description | string | |\r\n| currencyId | PlaceholderAssetConsumption->Currency_Id | integer | int64 |\r\n| currencyCode | PlaceholderAssetConsumption->Currency_Code | string | |\r\n| currencyDescription | PlaceholderAssetConsumption->Currency_Description | string | |\r\n| currencyRateId | PlaceholderAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateUserSuppliedConversionRate | PlaceholderAssetConsumption->CurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| currencyRateAppliedConversionRate | PlaceholderAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | PlaceholderAssetConsumption->CurrencyRateValue | number | decimal |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | PlaceholderAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | PlaceholderAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | PlaceholderAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | PlaceholderAssetConsumption->GeneralLedger_Description | string | |\r\n| locationId | PlaceholderAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | PlaceholderAssetConsumption->Location_Code | string | |\r\n| locationDescription | PlaceholderAssetConsumption->Location_Description | string | |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetConsumption->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetConsumption->Meter_Description | string | |\r\n| meterUnitOfMeasurementId | PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Id | integer | int64 |\r\n| meterUnitOfMeasurementCode | PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Code | string | |\r\n| meterUnitOfMeasurementDescription | PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Description | string | |\r\n| meterReadingId | PlaceholderAssetConsumption->MeterReading_Id | integer | int64 |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| notes | PlaceholderAssetConsumption->Notes | string | |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | PlaceholderAssetConsumption->Resource_Description | string | |\r\n| siteId | PlaceholderAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAssetConsumption->Site_Code | string | |\r\n| siteDescription | PlaceholderAssetConsumption->Site_Description | string | |\r\n| siteCurrencyId | PlaceholderAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | PlaceholderAssetConsumption->SiteCurrency_Code | string | |\r\n| siteCurrencyDescription | PlaceholderAssetConsumption->SiteCurrency_Description | string | |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | PlaceholderAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | PlaceholderAssetConsumption->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | PlaceholderAssetConsumption->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | PlaceholderAssetConsumption->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | PlaceholderAssetConsumption->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | PlaceholderAssetConsumption->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | PlaceholderAssetConsumption->StockItem_Warehouse_Description | string | |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | PlaceholderAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | PlaceholderAssetConsumption->Supplier_Description | string | |\r\n| totalCost | PlaceholderAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | PlaceholderAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | PlaceholderAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | PlaceholderAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n", "operationId": "BatchGetPlaceholderAssetConsumption", "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 Consumption 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 Consumption collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetConsumptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Batch": { "post": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Create a new collection of Placeholder Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| placeholderAssetId | PlaceholderAssetConsumption->PlaceholderAsset_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | PlaceholderAssetConsumption->Currency_Id | integer | int64 |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | PlaceholderAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| consumableId | Required | True | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | System Generated | true | If no value specified |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| unitPrice | System Generated | true | If no value specified |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetConsumption", "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/BatchCreatePlaceholderAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset Consumption 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 Consumption" ], "summary": "Update a collection of existing Placeholder Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetConsumption->Id | integer | int64 |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| resourceId | PlaceholderAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | PlaceholderAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | PlaceholderAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | PlaceholderAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | PlaceholderAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| quantity | PlaceholderAssetConsumption->Quantity | number | decimal |\r\n| meterId | PlaceholderAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | PlaceholderAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | PlaceholderAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | PlaceholderAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | PlaceholderAssetConsumption->Currency_Id | integer | int64 |\r\n| unitPrice | PlaceholderAssetConsumption->UnitPrice | number | decimal |\r\n| costCentreId | PlaceholderAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | PlaceholderAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | PlaceholderAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | PlaceholderAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | PlaceholderAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | PlaceholderAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | PlaceholderAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | Nullable | False | |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetConsumption", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Consumption 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": [ "Placeholder Asset Consumption" ], "summary": "Delete a collection of existing Placeholder Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetConsumption->Id | integer | int64 |\r\n| version | PlaceholderAssetConsumption->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": "BatchDeletePlaceholderAssetConsumption", "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/BatchDeletePlaceholderAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Consumption 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/PlaceholderAssets/Consumption/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Change the IsActive status for an existing Placeholder Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| isActive | PlaceholderAssetConsumption->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": "ChangePlaceholderAssetConsumptionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetConsumptionIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Change the PermissionTree for an existing Placeholder Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetConsumption->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": "ChangePlaceholderAssetConsumptionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetConsumptionPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/ValidateMeterAdr": { "post": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Validate whether the Meter Reading will cause the Meter's AverageDailyRate to exceed the allowed configured values.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| meterId | ValidateMeterAdrEntity->Meter_Id | integer | int64 |\r\n| meterReadingId | ValidateMeterAdrEntity->MeterReading_Id | integer | int64 |\r\n| readingValue | ValidateMeterAdrEntity->ReadingValue | number | decimal |\r\n| readingOn | ValidateMeterAdrEntity->ReadingOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "ValidatePlaceholderAssetConsumptionMeterAdr", "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/ValidateAssetConsumptionMeterAdrResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Consumption/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Consumption" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetConsumption->Id | integer | int64 |\r\n| version | PlaceholderAssetConsumption->Version | integer | int32 |\r\n| isActive | PlaceholderAssetConsumption->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": "BatchChangePlaceholderAssetConsumptionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetConsumptionIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Documents/{id}": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Get a collection of Placeholder Asset Document resources for the Placeholder Asset.", "description": "### Response Body\r\n#### 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 | PlaceholderAssetDocument->InheritedFrom_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetDocument->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetDocument->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetDocument->PlaceholderAsset_Description | string | |\r\n| developmentStatus | PlaceholderAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | PlaceholderAssetDocument->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetDocument->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetDocument->Unsynchronised | boolean | |\r\n| isActive | PlaceholderAssetDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Document", "schema": { "$ref": "#/definitions/GetPlaceholderAssetDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Document" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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": [ "Placeholder Asset Document" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetDocument->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": "DeletePlaceholderAssetDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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/PlaceholderAssets/{id}/Documents": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Get a collection of Placeholder Asset Document resources for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetDocument->IsInherited | boolean | |\r\n| inheritedFromId | PlaceholderAssetDocument->InheritedFrom_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n| createdOn | PlaceholderAssetDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetDocumentCollectionForPlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetDocumentCollectionForPlaceholderAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetDocument->Version | integer | int32 |\r\n| placeholderAssetCode | PlaceholderAssetDocument->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetDocument->PlaceholderAsset_Description | string | |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | PlaceholderAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetDocument->IsInherited | boolean | |\r\n| documentRecordId | PlaceholderAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | PlaceholderAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | PlaceholderAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | PlaceholderAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n| createdOn | PlaceholderAssetDocument->CreatedOn | string | date-time |\r\n| modifiedOn | PlaceholderAssetDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetPlaceholderAssetDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Document collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Document" ], "summary": "Create a new Placeholder Asset 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| placeholderAssetId | PlaceholderAssetDocument->PlaceholderAsset_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | 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": "CreatePlaceholderAssetDocument", "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/CreatePlaceholderAssetDocumentResourceActionRequest" } }, { "$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/PlaceholderAssets/Documents/Lookups/LookupPlaceholderAssetDocumentChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Lookups/LookupPlaceholderAssetDocument": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Lookup the for the Placeholder Asset 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": "LookupPlaceholderAssetDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Lookups/LookupPlaceholderAssetDocumentInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Lookups/LookupPlaceholderAssetDocumentPlaceholderAsset": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Lookup the Placeholder Asset Document for the Placeholder Asset 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 | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetDocumentPlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetDocumentPlaceholderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Document" ], "summary": "Get a collection of Placeholder Asset 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| inheritedFromId | PlaceholderAssetDocument->InheritedFrom_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetDocument->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetDocument->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetDocument->PlaceholderAsset_Description | string | |\r\n| developmentStatus | PlaceholderAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | PlaceholderAssetDocument->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetDocument->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetDocument->Unsynchronised | boolean | |\r\n| isActive | PlaceholderAssetDocument->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetDocument->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetDocument->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetDocument->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetDocument->Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | PlaceholderAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | PlaceholderAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | PlaceholderAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | PlaceholderAssetDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | PlaceholderAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | PlaceholderAssetDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | PlaceholderAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | PlaceholderAssetDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | PlaceholderAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPlaceholderAssetDocument", "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 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 Document collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Batch": { "post": { "tags": [ "Placeholder Asset Document" ], "summary": "Create a new collection of Placeholder Asset 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| placeholderAssetId | PlaceholderAssetDocument->PlaceholderAsset_Id | integer | int64 |\r\n| documentRecordId | PlaceholderAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | 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": "BatchCreatePlaceholderAssetDocument", "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/BatchCreatePlaceholderAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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 Document" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetDocument->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdatePlaceholderAssetDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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": [ "Placeholder Asset Document" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetDocument->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": "BatchDeletePlaceholderAssetDocument", "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/BatchDeletePlaceholderAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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/PlaceholderAssets/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Document" ], "summary": "Accept the Development Status for an existing Placeholder Asset Document resource.", "description": "", "operationId": "AcceptPlaceholderAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Document" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Document resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Document" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Document resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Document" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetDocument->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": "ChangePlaceholderAssetDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetDocumentIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Document" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetDocument->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": "ChangePlaceholderAssetDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetDocumentPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Document" ], "summary": "Reject the Development Status for an existing Placeholder Asset Document resource.", "description": "", "operationId": "RejectPlaceholderAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Documents/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Document" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetDocument->Version | integer | int32 |\r\n| isActive | PlaceholderAssetDocument->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": "BatchChangePlaceholderAssetDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetDocumentIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Document" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetDocument->Id | integer | int64 |\r\n| version | PlaceholderAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetDocument->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": "BatchChangePlaceholderAssetDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetDocumentPermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssets/Meters/{id}": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Get a Placeholder Asset Meter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | PlaceholderAssetMeter->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetMeter->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetMeter->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetMeter->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetMeter->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetMeter->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetMeter->Id | integer | int64 |\r\n| assetMeterType | PlaceholderAssetMeter->AssetMeterType | string (Allowed values: [PlaceholderAssetMeter]) | enum |\r\n| isMainMeter | PlaceholderAssetMeter->IsMainMeter | boolean | |\r\n| meterId | PlaceholderAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetMeter->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetMeter->Meter_Description | string | |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetMeter->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetMeter->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetMeter->PlaceholderAsset_Description | string | |\r\n| sequenceNumber | PlaceholderAssetMeter->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPlaceholderAssetMeter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Meter", "schema": { "$ref": "#/definitions/GetPlaceholderAssetMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Meter" ], "summary": "Update an existing Placeholder Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetMeter->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetMeter->SequenceNumber | integer | int32 |\r\n| isMainMeter | PlaceholderAssetMeter->IsMainMeter | boolean | |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetMeter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Meter was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Meter" ], "summary": "Delete an existing Placeholder Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetMeter->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": "DeletePlaceholderAssetMeter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Meter was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Get a collection of Placeholder Asset Meter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetMeter->Version | integer | int32 |\r\n| id | PlaceholderAssetMeter->Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetMeter->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetMeter->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetMeter->PlaceholderAsset_Description | string | |\r\n| meterId | PlaceholderAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetMeter->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetMeter->Meter_Description | string | |\r\n| isMainMeter | PlaceholderAssetMeter->IsMainMeter | boolean | |\r\n| sequenceNumber | PlaceholderAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n", "operationId": "GetPlaceholderAssetMeterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Meter" ], "summary": "Create a new Placeholder Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetMeter->PermissionTree_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetMeter->PlaceholderAsset_Id | integer | int64 |\r\n| meterId | PlaceholderAssetMeter->Meter_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | Min Value | >= 0| |\r\n| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetMeter", "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/CreatePlaceholderAssetMeterResourceActionRequest" } }, { "$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/PlaceholderAssets/{id}/Meters": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Get a collection of Placeholder Asset Meter resources for the Asset.", "description": "### Response Body\r\n#### 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 | PlaceholderAssetMeter->Version | integer | int32 |\r\n| id | PlaceholderAssetMeter->Id | integer | int64 |\r\n| meterId | PlaceholderAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetMeter->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetMeter->Meter_Description | string | |\r\n| isMainMeter | PlaceholderAssetMeter->IsMainMeter | boolean | |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n", "operationId": "GetPlaceholderAssetMeterForPlaceholderAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Meter collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetMeterForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/Lookups/LookupPlaceholderAssetMeterAsset": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Lookup the Placeholder Asset for the Placeholder Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n| siteId | PlaceholderAsset->Site_Id | integer | int64 |\r\n| siteCode | PlaceholderAsset->Site_Code | string | |\r\n| siteDescription | PlaceholderAsset->Site_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetMeterAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetMeterAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/Lookups/LookupPlaceholderAssetMeterChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Lookup the permission set for changing the Placeholder Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetMeterChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetMeterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/Lookups/LookupPlaceholderAssetMeterInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Lookup the permission set for creating the Placeholder Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupPlaceholderAssetMeterInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetMeterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/Lookups/LookupPlaceholderAssetMeterMeter": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Lookup the Meter for the Placeholder Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| siteCode | Meter->Site_Code | string | |\r\n| siteDescription | Meter->Site_Description | string | |\r\n", "operationId": "LookupPlaceholderAssetMeterMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter collection", "schema": { "$ref": "#/definitions/PlaceholderAssetMeterMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Meter" ], "summary": "Get a collection of Placeholder Asset Meter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | PlaceholderAssetMeter->IsActive | boolean | |\r\n| createdByUserId | PlaceholderAssetMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetMeter->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetMeter->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetMeter->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetMeter->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetMeter->PermissionTree_Description | string | |\r\n| id | PlaceholderAssetMeter->Id | integer | int64 |\r\n| assetMeterType | PlaceholderAssetMeter->AssetMeterType | string (Allowed values: [PlaceholderAssetMeter]) | enum |\r\n| isMainMeter | PlaceholderAssetMeter->IsMainMeter | boolean | |\r\n| meterId | PlaceholderAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | PlaceholderAssetMeter->Meter_Code | string | |\r\n| meterDescription | PlaceholderAssetMeter->Meter_Description | string | |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetMeter->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetMeter->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetMeter->PlaceholderAsset_Description | string | |\r\n| sequenceNumber | PlaceholderAssetMeter->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPlaceholderAssetMeter", "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 Meter id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Meter collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetMeterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/Batch": { "post": { "tags": [ "Placeholder Asset Meter" ], "summary": "Create a new collection of Placeholder Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | PlaceholderAssetMeter->PermissionTree_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetMeter->PlaceholderAsset_Id | integer | int64 |\r\n| meterId | PlaceholderAssetMeter->Meter_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | Min Value | >= 0| |\r\n| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetMeter", "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/BatchCreatePlaceholderAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset Meter batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Meter" ], "summary": "Update a collection of existing Placeholder Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetMeter->Id | integer | int64 |\r\n| version | PlaceholderAssetMeter->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetMeter->SequenceNumber | integer | int32 |\r\n| isMainMeter | PlaceholderAssetMeter->IsMainMeter | boolean | |\r\n| notes | PlaceholderAssetMeter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetMeter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Meter batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Meter" ], "summary": "Delete a collection of existing Placeholder Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetMeter->Id | integer | int64 |\r\n| version | PlaceholderAssetMeter->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": "BatchDeletePlaceholderAssetMeter", "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/BatchDeletePlaceholderAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Meter batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Meter" ], "summary": "Change the IsActive status for an existing Placeholder Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | PlaceholderAssetMeter->Version | integer | int32 |\r\n| isActive | PlaceholderAssetMeter->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": "ChangePlaceholderAssetMeterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetMeterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/{id}/SetMainMeterStatus": { "patch": { "tags": [ "Placeholder Asset Meter" ], "summary": "Set the Main Meter status.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetPlaceholderAssetMainMeterStatus->Version | integer | int32 |\r\n| isMainMeter | SetPlaceholderAssetMainMeterStatus->IsMainMeter | 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| isMainMeter | Required | True | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "SetPlaceholderAssetMainMeterStatus", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/SetMainPlaceholderAssetMeterStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Meters/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Meter" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetMeter->Id | integer | int64 |\r\n| version | PlaceholderAssetMeter->Version | integer | int32 |\r\n| isActive | PlaceholderAssetMeter->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": "BatchChangePlaceholderAssetMeterIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetMeterIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Responsibilities/{id}": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Get a Placeholder Asset 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 | PlaceholderAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| isActive | PlaceholderAssetResponsibility->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetResponsibility->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetResponsibility->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetResponsibility->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetResponsibility->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetResponsibility->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetResponsibility->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetResponsibility->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetResponsibility->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | PlaceholderAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| notes | PlaceholderAssetResponsibility->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetResponsibility->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetResponsibility->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetResponsibility->PlaceholderAsset_Description | string | |\r\n| recordType | PlaceholderAssetResponsibility->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | PlaceholderAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetResponsibility->Resource_Code | string | |\r\n| resourceResourceType | PlaceholderAssetResponsibility->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceContactDetailId | PlaceholderAssetResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | PlaceholderAssetResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | PlaceholderAssetResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | PlaceholderAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | PlaceholderAssetResponsibility->Section_Code | string | |\r\n| sectionDescription | PlaceholderAssetResponsibility->Section_Description | string | |\r\n| tradeId | PlaceholderAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | PlaceholderAssetResponsibility->Trade_Code | string | |\r\n| tradeDescription | PlaceholderAssetResponsibility->Trade_Description | string | |\r\n", "operationId": "GetPlaceholderAssetResponsibility", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Responsibility", "schema": { "$ref": "#/definitions/GetPlaceholderAssetResponsibilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetResponsibility->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdatePlaceholderAssetResponsibility", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetResponsibility->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": "DeletePlaceholderAssetResponsibility", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Responsibility 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/PlaceholderAssets/Responsibilities": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| isActive | PlaceholderAssetResponsibility->IsActive | boolean | |\r\n| placeholderAssetCode | PlaceholderAssetResponsibility->PlaceholderAsset_Code | string | |\r\n| tradeCode | PlaceholderAssetResponsibility->Trade_Code | string | |\r\n| sectionCode | PlaceholderAssetResponsibility->Section_Code | string | |\r\n| resourceCode | PlaceholderAssetResponsibility->Resource_Code | string | |\r\n| inheritedFromId | PlaceholderAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| isInherited | PlaceholderAssetResponsibility->IsInherited | boolean | |\r\n| developmentStatus | PlaceholderAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n", "operationId": "GetPlaceholderAssetResponsibilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Responsibility collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetResponsibilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Create a new Placeholder Asset 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| permissionTreeId | PlaceholderAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetResponsibility->PlaceholderAsset_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetResponsibility->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Nullable | False | |\r\n| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "CreatePlaceholderAssetResponsibility", "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/CreatePlaceholderAssetResponsibilityResourceActionRequest" } }, { "$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/PlaceholderAssets/{id}/Responsibilities": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Get a collection of Responsibilities for the Placeholder Asset.", "description": "### Response Body\r\n#### 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 | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| id | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| resourceId | PlaceholderAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetResponsibility->Resource_Code | string | |\r\n| tradeId | PlaceholderAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | PlaceholderAssetResponsibility->Trade_Code | string | |\r\n| sectionId | PlaceholderAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | PlaceholderAssetResponsibility->Section_Code | string | |\r\n| notes | PlaceholderAssetResponsibility->Notes | string | |\r\n| developmentStatus | PlaceholderAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetResponsibility->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetResponsibilityForPlaceholderAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Responsibility collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetResponsibilityForPlaceholderAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Lookups/LookupPlaceholderAssetResponsibilityChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetResponsibilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetResponsibilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Lookups/LookupPlaceholderAssetResponsibilityInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetResponsibilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Lookups/LookupPlaceholderAssetResponsibilityPlaceholderAsset": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Lookup the Regular Asset for the Placeholder Asset 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 | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetResponsibilityPlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetResponsibilityPlaceholderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Lookups/LookupPlaceholderAssetResponsibilityResource": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Lookup the Resource for the Placeholder Asset 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", "operationId": "LookupPlaceholderAssetResponsibilityResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetResponsibilityResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Lookups/LookupPlaceholderAssetResponsibilitySection": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Lookup the Section for the Placeholder Asset 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": "LookupPlaceholderAssetResponsibilitySection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetResponsibilitySectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Lookups/LookupPlaceholderAssetResponsibilityTrade": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Lookup the Trade for the Placeholder Asset 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": "LookupPlaceholderAssetResponsibilityTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetResponsibilityTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| isActive | PlaceholderAssetResponsibility->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetResponsibility->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetResponsibility->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetResponsibility->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetResponsibility->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetResponsibility->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetResponsibility->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetResponsibility->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetResponsibility->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | PlaceholderAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| notes | PlaceholderAssetResponsibility->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetResponsibility->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetResponsibility->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetResponsibility->PlaceholderAsset_Description | string | |\r\n| recordType | PlaceholderAssetResponsibility->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| resourceId | PlaceholderAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | PlaceholderAssetResponsibility->Resource_Code | string | |\r\n| resourceResourceType | PlaceholderAssetResponsibility->Resource_ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| resourceContactDetailId | PlaceholderAssetResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | PlaceholderAssetResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | PlaceholderAssetResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | PlaceholderAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | PlaceholderAssetResponsibility->Section_Code | string | |\r\n| sectionDescription | PlaceholderAssetResponsibility->Section_Description | string | |\r\n| tradeId | PlaceholderAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | PlaceholderAssetResponsibility->Trade_Code | string | |\r\n| tradeDescription | PlaceholderAssetResponsibility->Trade_Description | string | |\r\n", "operationId": "BatchGetPlaceholderAssetResponsibility", "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 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 Responsibility collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetResponsibilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Batch": { "post": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Create a new collection of Placeholder Asset 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| permissionTreeId | PlaceholderAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| placeholderAssetId | PlaceholderAssetResponsibility->PlaceholderAsset_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetResponsibility->Notes | string | |\r\n\r\n#### Business 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| placeholderAssetId | Nullable | False | |\r\n| sectionId | Nullable | False | |\r\n| tradeId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePlaceholderAssetResponsibility", "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/BatchCreatePlaceholderAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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 Responsibility" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | PlaceholderAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | PlaceholderAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | PlaceholderAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | PlaceholderAssetResponsibility->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdatePlaceholderAssetResponsibility", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset 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" } } }, "delete": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetResponsibility->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeletePlaceholderAssetResponsibility", "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/BatchDeletePlaceholderAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Responsibility 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/PlaceholderAssets/Responsibilities/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Accept the Development Status for an existing Placeholder Asset Responsibility resource.", "description": "", "operationId": "AcceptPlaceholderAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Responsibility resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Responsibility id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Responsibility resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Responsibility 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/PlaceholderAssets/Responsibilities/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| isActive | PlaceholderAssetResponsibility->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": "ChangePlaceholderAssetResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetResponsibilityIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetResponsibility->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": "ChangePlaceholderAssetResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetResponsibilityPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Responsibilities/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Reject the Development Status for an existing Placeholder Asset Responsibility resource.", "description": "", "operationId": "RejectPlaceholderAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Responsibility 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/PlaceholderAssets/Responsibilities/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| isActive | PlaceholderAssetResponsibility->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": "BatchChangePlaceholderAssetResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetResponsibilityIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Responsibilities/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Responsibility" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetResponsibility->Id | integer | int64 |\r\n| version | PlaceholderAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetResponsibility->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": "BatchChangePlaceholderAssetResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetResponsibilityPermissionTreeResourceActionRequest" } }, { "$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/PlaceholderAssets/Spares/{id}": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Get a Placeholder Asset 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 | PlaceholderAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetSpare->Id | integer | int64 |\r\n| isActive | PlaceholderAssetSpare->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetSpare->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetSpare->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetSpare->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetSpare->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetSpare->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | PlaceholderAssetSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAssetSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromMaterialMasterId | PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetSpare->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetSpare->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetSpare->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetSpare->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetSpare->PlaceholderAsset_Description | string | |\r\n| recordType | PlaceholderAssetSpare->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "GetPlaceholderAssetSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Placeholder Asset Spare", "schema": { "$ref": "#/definitions/GetPlaceholderAssetSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Placeholder Asset Spare" ], "summary": "Update an existing Placeholder Asset 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 | PlaceholderAssetSpare->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetSpare->Notes | string | |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| materialMasterId | Nullable | False | |\r\n\r\n", "operationId": "UpdatePlaceholderAssetSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePlaceholderAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Spare was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Spare" ], "summary": "Delete an existing Placeholder Asset 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 | PlaceholderAssetSpare->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": "DeletePlaceholderAssetSpare", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePlaceholderAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Spare was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetSpare->Version | integer | int32 |\r\n| placeholderAssetId | PlaceholderAssetSpare->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetSpare->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetSpare->PlaceholderAsset_Description | string | |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetSpare->MaterialMaster_Description | string | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| developmentStatus | PlaceholderAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetSpare->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Spare collection", "schema": { "$ref": "#/definitions/GetPlaceholderAssetSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Placeholder Asset Spare" ], "summary": "Create a new Placeholder Asset 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| placeholderAssetId | PlaceholderAssetSpare->PlaceholderAsset_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | 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": "CreatePlaceholderAssetSpare", "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/CreatePlaceholderAssetSpareResourceActionRequest" } }, { "$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/PlaceholderAssets/{id}/Spares": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Get a collection of Spare resources for the Placeholder Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PlaceholderAssetSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetSpare->Version | integer | int32 |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetSpare->MaterialMaster_Description | string | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| developmentStatus | PlaceholderAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | PlaceholderAssetSpare->IsInherited | boolean | |\r\n", "operationId": "GetPlaceholderAssetSpareForPlaceholderAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Placeholder Asset Spare collection", "schema": { "$ref": "#/definitions/GetSpareForPlaceholderAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Lookups/LookupPlaceholderAssetSpareChangePermissionTree": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Lookup the permission set for changing the Placeholder Asset 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": "LookupPlaceholderAssetSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Lookups/LookupPlaceholderAssetSpareInsertPermissionTree": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Lookup the permission set for creating the Placeholder Asset 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": "LookupPlaceholderAssetSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Lookups/LookupPlaceholderAssetSpareMaterialMaster": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Lookup the Material Master for the Placeholder Asset 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": "LookupPlaceholderAssetSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/PlaceholderAssetSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Lookups/LookupPlaceholderAssetSparePlaceholderAsset": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Lookup the Placeholder Asset for the Placeholder Asset 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 | PlaceholderAsset->Id | integer | int64 |\r\n| code | PlaceholderAsset->Code | string | |\r\n| description | PlaceholderAsset->Description | string | |\r\n", "operationId": "LookupPlaceholderAssetSparePlaceholderAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/PlaceholderAssetSparePlaceholderAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Batch/{ids}": { "get": { "tags": [ "Placeholder Asset Spare" ], "summary": "Get a collection of Placeholder Asset 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 | PlaceholderAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | PlaceholderAssetSpare->Id | integer | int64 |\r\n| isActive | PlaceholderAssetSpare->IsActive | boolean | |\r\n| isHistorical | PlaceholderAssetSpare->IsHistorical | boolean | |\r\n| isInherited | PlaceholderAssetSpare->IsInherited | boolean | |\r\n| isProposed | PlaceholderAssetSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | PlaceholderAssetSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | PlaceholderAssetSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | PlaceholderAssetSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | PlaceholderAssetSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | PlaceholderAssetSpare->Unsynchronised | boolean | |\r\n| createdByUserId | PlaceholderAssetSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PlaceholderAssetSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PlaceholderAssetSpare->CreatedByUser_FullName | string | |\r\n| createdOn | PlaceholderAssetSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | PlaceholderAssetSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PlaceholderAssetSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PlaceholderAssetSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PlaceholderAssetSpare->ModifiedOn | string | date-time |\r\n| version | PlaceholderAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PlaceholderAssetSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PlaceholderAssetSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | PlaceholderAssetSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | PlaceholderAssetSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromMaterialMasterId | PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | PlaceholderAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | PlaceholderAssetSpare->MaterialMaster_Description | string | |\r\n| notes | PlaceholderAssetSpare->Notes | string | |\r\n| placeholderAssetId | PlaceholderAssetSpare->PlaceholderAsset_Id | integer | int64 |\r\n| placeholderAssetCode | PlaceholderAssetSpare->PlaceholderAsset_Code | string | |\r\n| placeholderAssetDescription | PlaceholderAssetSpare->PlaceholderAsset_Description | string | |\r\n| recordType | PlaceholderAssetSpare->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "BatchGetPlaceholderAssetSpare", "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 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 Spare collection", "schema": { "$ref": "#/definitions/BatchGetPlaceholderAssetSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Batch": { "post": { "tags": [ "Placeholder Asset Spare" ], "summary": "Create a new collection of Placeholder Asset 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| placeholderAssetId | PlaceholderAssetSpare->PlaceholderAsset_Id | integer | int64 |\r\n| permissionTreeId | PlaceholderAssetSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | PlaceholderAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| placeholderAssetId | Required | True | |\r\n| placeholderAssetId | Nullable | False | |\r\n| placeholderAssetId | 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": "BatchCreatePlaceholderAssetSpare", "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/BatchCreatePlaceholderAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Placeholder Asset 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 Spare" ], "summary": "Update a collection of existing Placeholder Asset 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 | PlaceholderAssetSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetSpare->Version | integer | int32 |\r\n| sequenceNumber | PlaceholderAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | PlaceholderAssetSpare->IsCritical | boolean | |\r\n| isEmergency | PlaceholderAssetSpare->IsEmergency | boolean | |\r\n| notes | PlaceholderAssetSpare->Notes | string | |\r\n| materialMasterId | PlaceholderAssetSpare->MaterialMaster_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| materialMasterId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePlaceholderAssetSpare", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdatePlaceholderAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Spare batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Placeholder Asset Spare" ], "summary": "Delete a collection of existing Placeholder Asset 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 | PlaceholderAssetSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetSpare->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeletePlaceholderAssetSpare", "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/BatchDeletePlaceholderAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Placeholder Asset Spare batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Spare" ], "summary": "Accept the Development Status for an existing Placeholder Asset Spare resource.", "description": "", "operationId": "AcceptPlaceholderAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Placeholder Asset Spare" ], "summary": "Accept the Development Status for the collection of existing Placeholder Asset Spare resource id's.", "description": "", "operationId": "BatchAcceptPlaceholderAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Spare" ], "summary": "Reject the Development Status for the collection of existing Placeholder Asset Spare resource id's.", "description": "", "operationId": "BatchRejectPlaceholderAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Placeholder Asset Spare 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/PlaceholderAssets/Spares/{id}/Active": { "patch": { "tags": [ "Placeholder Asset Spare" ], "summary": "Change the IsActive status for an existing Placeholder Asset 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 | PlaceholderAssetSpare->Version | integer | int32 |\r\n| isActive | PlaceholderAssetSpare->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": "ChangePlaceholderAssetSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetSpareIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Spare" ], "summary": "Change the PermissionTree for an existing Placeholder Asset 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 | PlaceholderAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetSpare->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": "ChangePlaceholderAssetSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePlaceholderAssetSparePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/PlaceholderAssets/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Placeholder Asset Spare" ], "summary": "Reject the Development Status for an existing Placeholder Asset Spare resource.", "description": "", "operationId": "RejectPlaceholderAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Placeholder Asset Spare 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/PlaceholderAssets/Spares/Batch/Active": { "patch": { "tags": [ "Placeholder Asset Spare" ], "summary": "Change the IsActive status for a collection of existing Placeholder Asset 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 | PlaceholderAssetSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetSpare->Version | integer | int32 |\r\n| isActive | PlaceholderAssetSpare->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": "BatchChangePlaceholderAssetSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetSpareIsActiveResourceActionRequest" } }, { "$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/PlaceholderAssets/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Placeholder Asset Spare" ], "summary": "Change the PermissionTree status for a collection of existing Placeholder Asset 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 | PlaceholderAssetSpare->Id | integer | int64 |\r\n| version | PlaceholderAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | PlaceholderAssetSpare->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": "BatchChangePlaceholderAssetSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangePlaceholderAssetSparePermissionTreeResourceActionRequest" } }, { "$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/RegularAssets/{id}": { "get": { "tags": [ "Regular Asset" ], "summary": "Get a Regular Asset 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| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | RegularAsset->Calendar_Code | string | |\r\n| calendarDescription | RegularAsset->Calendar_Description | string | |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAsset->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAsset->CostCentre_Description | string | |\r\n| developmentStatus | RegularAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAsset->GeneralLedger_Description | string | |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| isActive | RegularAsset->IsActive | boolean | |\r\n| isHistorical | RegularAsset->IsHistorical | boolean | |\r\n| isInherited | RegularAsset->IsInherited | boolean | |\r\n| isProposed | RegularAsset->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAsset->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAsset->LastConfirmedOn | string | date-time |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| locationCode | RegularAsset->Location_Code | string | |\r\n| locationDescription | RegularAsset->Location_Description | string | |\r\n| nearestRegularAssetId | RegularAsset->NearestRegularAsset_Id | integer | int64 |\r\n| parentAssetId | RegularAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | RegularAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | RegularAsset->ParentAsset_Description | string | |\r\n| parentAssetRecordType | RegularAsset->ParentAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| siteId | RegularAsset->Site_Id | integer | int64 |\r\n| siteCode | RegularAsset->Site_Code | string | |\r\n| siteDescription | RegularAsset->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | RegularAsset->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationFailedReason | RegularAsset->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAsset->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAsset->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | RegularAsset->Unsubscribed | boolean | |\r\n| code | RegularAsset->Code | string | |\r\n| geographicId | RegularAsset->GeographicId | integer | int64 |\r\n| geographicEndPosition | RegularAsset->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | RegularAsset->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | RegularAsset->GeographicLength | number | decimal |\r\n| geographicLocation | RegularAsset->GeographicLocation | object | |\r\n| geographicNotes | RegularAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityId | RegularAsset->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | RegularAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | RegularAsset->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | RegularAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | RegularAsset->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | RegularAsset->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | RegularAsset->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAsset->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAsset->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAsset->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAsset->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAsset->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAsset->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAsset->ModifiedOn | string | date-time |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| permissionTreeId | RegularAsset->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAsset->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAsset->PermissionTree_Description | string | |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | RegularAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | RegularAsset->AcquisitionStatus_Description | string | |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | RegularAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | RegularAsset->AcquisitionType_Description | string | |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAsset->AssetImportance_Description | string | |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAsset->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAsset->AssetType_Description | string | |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | RegularAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | RegularAsset->CommissioningWorkOrder_Description | string | |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| description | RegularAsset->Description | string | |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| inheritedFromId | RegularAsset->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAsset->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| isOptionsUsed | RegularAsset->IsOptionsUsed | boolean | |\r\n| isPermitRequired | RegularAsset->IsPermitRequired | boolean | |\r\n| isRunning | RegularAsset->IsRunning | boolean | |\r\n| notes | RegularAsset->Notes | string | |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| recordType | RegularAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | RegularAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | RegularAsset->ReplacementAsset_Description | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAsset->Supplier_Code | string | |\r\n| supplierDescription | RegularAsset->Supplier_Description | string | |\r\n| taskRollUpPointId | RegularAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAsset->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAsset->TaskRollUpPoint_Description | string | |\r\n| treePathId | RegularAsset->TreePathId | integer | int64 |\r\n| treePathItems | RegularAsset->TreePathItems | array | array |\r\n| warranty | RegularAsset->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetRegularAsset", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset", "schema": { "$ref": "#/definitions/GetRegularAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset" ], "summary": "Update an existing Regular Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| isPermitRequired | RegularAsset->IsPermitRequired | boolean | |\r\n| isRunning | RegularAsset->IsRunning | boolean | |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| notes | RegularAsset->Notes | string | |\r\n| geographicLocation | RegularAsset->GeographicLocation | object | |\r\n| geographicStartPosition | RegularAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | RegularAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | RegularAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | RegularAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | RegularAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | RegularAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | RegularAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isMsi | Nullable | False | |\r\n| isForScheduledWorkOnly | Nullable | False | |\r\n| isRunning | Nullable | False | |\r\n| taskRollUpPointId | Nullable | True | RegularAsset->IsMsi eq false |\r\n| calendarId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAsset", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-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" ], "summary": "Delete an existing Regular Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAsset->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": "DeleteRegularAsset", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssets": { "get": { "tags": [ "Regular Asset" ], "summary": "Get a collection of Regular Asset 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 | RegularAsset->Version | integer | int32 |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| isActive | RegularAsset->IsActive | boolean | |\r\n| siteId | RegularAsset->Site_Id | integer | int64 |\r\n| siteCode | RegularAsset->Site_Code | string | |\r\n| siteDescription | RegularAsset->Site_Description | string | |\r\n| parentAssetId | RegularAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | RegularAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | RegularAsset->ParentAsset_Description | string | |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| recordType | RegularAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| locationCode | RegularAsset->Location_Code | string | |\r\n| locationDescription | RegularAsset->Location_Description | string | |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAsset->AssetImportance_Description | string | |\r\n| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | RegularAsset->Calendar_Code | string | |\r\n| calendarDescription | RegularAsset->Calendar_Description | string | |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAsset->GeneralLedger_Description | string | |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | RegularAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | RegularAsset->CommissioningWorkOrder_Description | string | |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAsset->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAsset->CostCentre_Description | string | |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAsset->Supplier_Code | string | |\r\n| supplierDescription | RegularAsset->Supplier_Description | string | |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | RegularAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | RegularAsset->AcquisitionType_Description | string | |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | RegularAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | RegularAsset->AcquisitionStatus_Description | string | |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | RegularAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | RegularAsset->ReplacementAsset_Description | string | |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| notes | RegularAsset->Notes | string | |\r\n| permissionTreeCode | RegularAsset->PermissionTree_Code | string | |\r\n| createdOn | RegularAsset->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAsset->ModifiedOn | string | date-time |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAsset->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAsset->AssetType_Description | string | |\r\n| rulesLastEvaluatedOn | RegularAsset->RulesLastEvaluatedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAsset->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | RegularAsset->IsHistorical | boolean | |\r\n| isInherited | RegularAsset->IsInherited | boolean | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| inheritedFromId | RegularAsset->InheritedFrom_Id | integer | int64 |\r\n| ruleEvaluationPassed | RegularAsset->RuleEvaluationPassed | boolean | |\r\n| developmentStatus | RegularAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| unsynchronised | RegularAsset->Unsynchronised | boolean | |\r\n| treePathItems | RegularAsset->TreePathItems | array | array |\r\n", "operationId": "GetRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/GetRegularAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset" ], "summary": "Create a new Regular Asset resource.", "description": "### Request Body\r\n#### 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 | RegularAsset->PermissionTree_Id | integer | int64 |\r\n| siteId | RegularAsset->Site_Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| parentAssetId | RegularAsset->ParentAsset_Id | integer | int64 |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| isPermitRequired | RegularAsset->IsPermitRequired | boolean | |\r\n| isRunning | RegularAsset->IsRunning | boolean | |\r\n| notes | RegularAsset->Notes | string | |\r\n| geographicLocation | RegularAsset->GeographicLocation | object | |\r\n| geographicStartPosition | RegularAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | RegularAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | RegularAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | RegularAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | RegularAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | RegularAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | RegularAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | 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| isMsi | Required | True | |\r\n| isMsi | Nullable | False | |\r\n| parentAssetId | Required | True | |\r\n| parentAssetId | Nullable | False | |\r\n| parentAssetId | Min Value | >= 1| |\r\n| taskRollUpPointId | Nullable | True | RegularAsset->IsMsi eq false |\r\n| calendarId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| isForScheduledWorkOnly | Required | True | |\r\n| isForScheduledWorkOnly | Nullable | False | |\r\n| isRunning | Required | True | |\r\n| isRunning | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAsset", "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/CreateRegularAssetResourceActionRequest" } }, { "$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/RegularAssets/Lookups/LookupRegularAssetAcquisitionStatus": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Acquisition Status for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AcquisitionStatus->Id | integer | int64 |\r\n| code | AcquisitionStatus->Code | string | |\r\n| description | AcquisitionStatus->Description | string | |\r\n", "operationId": "LookupRegularAssetAcquisitionStatus", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Acquisition Status collection", "schema": { "$ref": "#/definitions/RegularAssetAcquisitionStatusLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetAcquisitionType": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Acquisition Type for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AcquisitionType->Id | integer | int64 |\r\n| code | AcquisitionType->Code | string | |\r\n| description | AcquisitionType->Description | string | |\r\n", "operationId": "LookupRegularAssetAcquisitionType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Acquisition Type collection", "schema": { "$ref": "#/definitions/RegularAssetAcquisitionTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetAssetParent": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Regular Asset for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| siteId | Asset->Site_Id | integer | int64 |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupRegularAssetAssetParent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/RegularAssetAssetParentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetCalendar": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Calendar for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Calendar->Id | integer | int64 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n", "operationId": "LookupRegularAssetCalendar", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Calendar collection", "schema": { "$ref": "#/definitions/RegularAssetCalendarLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetChangePermissionTree": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the permission set for changing the Regular Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetCommissioningWorkOrder": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Work Order for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupRegularAssetCommissioningWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Work Order collection", "schema": { "$ref": "#/definitions/RegularAssetCommissioningWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetCostCentre": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Cost Centre for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupRegularAssetCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/RegularAssetCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetGeneralLedger": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the General Ledger for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupRegularAssetGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/RegularAssetGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetGeographicAssetReferenceEntity": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Asset for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| siteCode | Asset->Site_Code | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| geographicLocation | Asset->GeographicLocation | object | |\r\n", "operationId": "LookupRegularAssetGeographicAssetReferenceEntity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/RegularAssetGeographicDataAssetEntityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetImportance": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Asset Importance for the Regular Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetInsertPermissionTree": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the permission set for creating the Regular Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetLocation": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Location for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n", "operationId": "LookupRegularAssetLocation", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Location collection", "schema": { "$ref": "#/definitions/RegularAssetLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetRegularAssetType": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Regular Asset Type for the Regular Asset.", "description": "### Response Body\r\n#### Payload\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| canSelectOnAsset | RegularAssetType->CanSelectOnAsset | boolean | |\r\n", "operationId": "LookupRegularAssetRegularAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetRegularAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetReplacementAsset": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Replacement Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetReplacementAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetReplacementAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetSite": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Site for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| isVirtual | Site->IsVirtual | boolean | |\r\n", "operationId": "LookupRegularAssetSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/RegularAssetSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetSupplier": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Supplier for the Regular Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Lookups/LookupRegularAssetTaskRollUpPoint": { "get": { "tags": [ "Regular Asset" ], "summary": "Lookup the Task Roll Up Point for the Regular Asset.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Batch/{ids}": { "get": { "tags": [ "Regular Asset" ], "summary": "Get a collection of Regular Asset 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| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| calendarCode | RegularAsset->Calendar_Code | string | |\r\n| calendarDescription | RegularAsset->Calendar_Description | string | |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAsset->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAsset->CostCentre_Description | string | |\r\n| developmentStatus | RegularAsset->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAsset->GeneralLedger_Description | string | |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| isActive | RegularAsset->IsActive | boolean | |\r\n| isHistorical | RegularAsset->IsHistorical | boolean | |\r\n| isInherited | RegularAsset->IsInherited | boolean | |\r\n| isProposed | RegularAsset->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAsset->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAsset->LastConfirmedOn | string | date-time |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| locationCode | RegularAsset->Location_Code | string | |\r\n| locationDescription | RegularAsset->Location_Description | string | |\r\n| nearestRegularAssetId | RegularAsset->NearestRegularAsset_Id | integer | int64 |\r\n| parentAssetId | RegularAsset->ParentAsset_Id | integer | int64 |\r\n| parentAssetCode | RegularAsset->ParentAsset_Code | string | |\r\n| parentAssetDescription | RegularAsset->ParentAsset_Description | string | |\r\n| parentAssetRecordType | RegularAsset->ParentAsset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| siteId | RegularAsset->Site_Id | integer | int64 |\r\n| siteCode | RegularAsset->Site_Code | string | |\r\n| siteDescription | RegularAsset->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | RegularAsset->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAsset->Unsynchronised | boolean | |\r\n| ruleEvaluationFailedReason | RegularAsset->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAsset->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAsset->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | RegularAsset->Unsubscribed | boolean | |\r\n| code | RegularAsset->Code | string | |\r\n| geographicId | RegularAsset->GeographicId | integer | int64 |\r\n| geographicEndPosition | RegularAsset->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | RegularAsset->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | RegularAsset->GeographicLength | number | decimal |\r\n| geographicLocation | RegularAsset->GeographicLocation | object | |\r\n| geographicNotes | RegularAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityId | RegularAsset->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | RegularAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | RegularAsset->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | RegularAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | RegularAsset->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | RegularAsset->GeographicUnitOfMeasurement_Code | string | |\r\n| createdByUserId | RegularAsset->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAsset->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAsset->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAsset->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAsset->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAsset->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAsset->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAsset->ModifiedOn | string | date-time |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| permissionTreeId | RegularAsset->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAsset->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAsset->PermissionTree_Description | string | |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| acquisitionStatusCode | RegularAsset->AcquisitionStatus_Code | string | |\r\n| acquisitionStatusDescription | RegularAsset->AcquisitionStatus_Description | string | |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionTypeCode | RegularAsset->AcquisitionType_Code | string | |\r\n| acquisitionTypeDescription | RegularAsset->AcquisitionType_Description | string | |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAsset->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAsset->AssetImportance_Description | string | |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAsset->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAsset->AssetType_Description | string | |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | RegularAsset->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | RegularAsset->CommissioningWorkOrder_Description | string | |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| description | RegularAsset->Description | string | |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| inheritedFromId | RegularAsset->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAsset->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| isOptionsUsed | RegularAsset->IsOptionsUsed | boolean | |\r\n| isPermitRequired | RegularAsset->IsPermitRequired | boolean | |\r\n| isRunning | RegularAsset->IsRunning | boolean | |\r\n| notes | RegularAsset->Notes | string | |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| recordType | RegularAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| replacementAssetCode | RegularAsset->ReplacementAsset_Code | string | |\r\n| replacementAssetDescription | RegularAsset->ReplacementAsset_Description | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAsset->Supplier_Code | string | |\r\n| supplierDescription | RegularAsset->Supplier_Description | string | |\r\n| taskRollUpPointId | RegularAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAsset->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAsset->TaskRollUpPoint_Description | string | |\r\n| treePathId | RegularAsset->TreePathId | integer | int64 |\r\n| treePathItems | RegularAsset->TreePathItems | array | array |\r\n| warranty | RegularAsset->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "BatchGetRegularAsset", "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 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 collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Batch": { "post": { "tags": [ "Regular Asset" ], "summary": "Create a new collection of Regular Asset resources.", "description": "### Request Body\r\n#### 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 | RegularAsset->PermissionTree_Id | integer | int64 |\r\n| siteId | RegularAsset->Site_Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| parentAssetId | RegularAsset->ParentAsset_Id | integer | int64 |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| isPermitRequired | RegularAsset->IsPermitRequired | boolean | |\r\n| isRunning | RegularAsset->IsRunning | boolean | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| notes | RegularAsset->Notes | string | |\r\n| geographicLocation | RegularAsset->GeographicLocation | object | |\r\n| geographicStartPosition | RegularAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | RegularAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | RegularAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | RegularAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | RegularAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | RegularAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | RegularAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | 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| parentAssetId | Required | True | |\r\n| parentAssetId | Nullable | False | |\r\n| parentAssetId | Min Value | >= 1| |\r\n| isRunning | Required | True | |\r\n| isRunning | Nullable | False | |\r\n| isMsi | Required | True | |\r\n| isMsi | Nullable | False | |\r\n| taskRollUpPointId | Nullable | True | RegularAsset->IsMsi eq false |\r\n| calendarId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| isForScheduledWorkOnly | Required | True | |\r\n| isForScheduledWorkOnly | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAsset", "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/BatchCreateRegularAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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" ], "summary": "Update a collection of existing Regular Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| isPermitRequired | RegularAsset->IsPermitRequired | boolean | |\r\n| isRunning | RegularAsset->IsRunning | boolean | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| notes | RegularAsset->Notes | string | |\r\n| geographicLocation | RegularAsset->GeographicLocation | object | |\r\n| geographicStartPosition | RegularAsset->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | RegularAsset->GeographicEndPosition | number | decimal |\r\n| geographicLength | RegularAsset->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | RegularAsset->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | RegularAsset->GeographicNotes | string | |\r\n| geographicReferenceEntityType | RegularAsset->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | RegularAsset->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isRunning | Nullable | False | |\r\n| isMsi | Nullable | False | |\r\n| taskRollUpPointId | Nullable | True | RegularAsset->IsMsi eq false |\r\n| calendarId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| isForScheduledWorkOnly | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAsset", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" ], "summary": "Delete a collection of existing Regular Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| version | RegularAsset->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": "BatchDeleteRegularAsset", "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/BatchDeleteRegularAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssets/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset" ], "summary": "Accept the Development Status for an existing Regular Asset resource.", "description": "", "operationId": "AcceptRegularAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset" ], "summary": "Accept the Development Status for the collection of existing Regular Asset resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset" ], "summary": "Reject the Development Status for the collection of existing Regular Asset resource id's.", "description": "", "operationId": "BatchRejectRegularAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Batch/{ids}/Sync": { "post": { "tags": [ "Regular Asset" ], "summary": "Synchronise the collection of existing Regular Asset resource id's.", "description": "", "operationId": "BatchSyncRegularAsset", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{id}/ChangeType/{assetType}": { "patch": { "tags": [ "Regular Asset" ], "summary": "Change the Asset Type of a Regular Asset", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetChangeAssetType->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": "ChangeRegularAssetAssetType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "type": "integer", "name": "assetType", "in": "path", "required": true, "description": "Resource property to use as value", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetAssetTypeResourceActionRequest" } }, { "type": "boolean", "name": "KeepOriginalRootItems", "in": "query", "description": "Keep original items directly under the Asset (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{id}/Active": { "patch": { "tags": [ "Regular Asset" ], "summary": "Change the IsActive status for an existing Regular Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| isActive | RegularAsset->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": "ChangeRegularAssetIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssets/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset" ], "summary": "Change the PermissionTree for an existing Regular Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| permissionTreeId | RegularAsset->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": "ChangeRegularAssetPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssets/Move": { "post": { "tags": [ "Regular Asset" ], "summary": "Move Regular Asset.", "description": "### Request Body\r\n#### 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| inheritParentCostCentre | MoveEntity->InheritParentCostCentre | boolean | |\r\n| inheritParentLocation | MoveEntity->InheritParentLocation | boolean | |\r\n| synchroniseMetersWithAssetSiteAndPermissionTree | MoveEntity->SynchroniseMetersWithAssetSiteAndPermissionTree | 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| sourceId | Required | True | |\r\n| sourceId | Nullable | False | |\r\n| targetId | Required | True | |\r\n| targetId | Nullable | False | |\r\n\r\n", "operationId": "MoveRegularAsset", "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/MoveRegularAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{id}/Site": { "patch": { "tags": [ "Regular Asset" ], "summary": "Change the Site on a Regular Asset.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| siteId | RegularAssetSiteChange->SiteId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRegularAssetSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset" ], "summary": "Reject the Development Status for an existing Regular Asset resource.", "description": "", "operationId": "RejectRegularAssetDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Sync/Resubscribe": { "post": { "tags": [ "Regular Asset" ], "summary": "Accept the Development Status for an existing Regular Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "ResubscribeRegularAssetDevelopmentStatus", "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/ResubscribeRegularAssetDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{id}/Sync": { "post": { "tags": [ "Regular Asset" ], "summary": "Synchronise the existing Regular Asset resource.", "description": "", "operationId": "SyncRegularAsset", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Sync/Unsubscribe": { "post": { "tags": [ "Regular Asset" ], "summary": "Accept the Development Status for an existing Regular Asset resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "UnsubscribeRegularAssetDevelopmentStatus", "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/UnsubscribeRegularAssetDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Batch/ChangeType": { "patch": { "tags": [ "Regular Asset" ], "summary": "Change the Asset Type of a list of Regular Assets", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetChangeAssetType->Id | integer | int64 |\r\n| version | RegularAssetChangeAssetType->Version | integer | int32 |\r\n| assetTypeId | RegularAssetChangeAssetType->AssetType_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| assetTypeId | Required | True | |\r\n| assetTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRegularAssetAssetType", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetAssetTypeResourceActionRequest" } }, { "type": "boolean", "name": "KeepOriginalRootItems", "in": "query", "description": "Keep original items directly under the Asset (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Batch/Active": { "patch": { "tags": [ "Regular Asset" ], "summary": "Change the IsActive status for a collection of existing Regular Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| isActive | RegularAsset->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": "BatchChangeRegularAssetIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssets/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| permissionTreeId | RegularAsset->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": "BatchChangeRegularAssetPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssets/MatchBatch": { "patch": { "tags": [ "Regular Asset" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| version | RegularAsset->Version | integer | int32 |\r\n| description | RegularAsset->Description | string | |\r\n| qRCode | RegularAsset->QRCode | string | |\r\n| rFId | RegularAsset->RFId | string | |\r\n| serialNumber | RegularAsset->SerialNumber | string | |\r\n| sequenceNumber | RegularAsset->SequenceNumber | integer | int32 |\r\n| barcode | RegularAsset->Barcode | string | |\r\n| isPermitRequired | RegularAsset->IsPermitRequired | boolean | |\r\n| isRunning | RegularAsset->IsRunning | boolean | |\r\n| isMsi | RegularAsset->IsMsi | boolean | |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| assetImportanceId | RegularAsset->AssetImportance_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAsset->TaskRollUpPoint_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAsset->CommissioningWorkOrder_Id | integer | int64 |\r\n| calendarId | RegularAsset->Calendar_Id | integer | int64 |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| purchaseAmount | RegularAsset->PurchaseAmount | number | decimal |\r\n| currentValue | RegularAsset->CurrentValue | number | decimal |\r\n| supplierId | RegularAsset->Supplier_Id | integer | int64 |\r\n| acquisitionTypeId | RegularAsset->AcquisitionType_Id | integer | int64 |\r\n| acquisitionStatusId | RegularAsset->AcquisitionStatus_Id | integer | int64 |\r\n| replacementAssetId | RegularAsset->ReplacementAsset_Id | integer | int64 |\r\n| budgetedReplacementAmount | RegularAsset->BudgetedReplacementAmount | number | decimal |\r\n| downtimeCostPerHour | RegularAsset->DowntimeCostPerHour | number | decimal |\r\n| insuredValue | RegularAsset->InsuredValue | number | decimal |\r\n| commissionedOn | RegularAsset->CommissionedOn | string | date |\r\n| expectedReplacementDate | RegularAsset->ExpectedReplacementDate | string | date |\r\n| dateOfCurrentValue | RegularAsset->DateOfCurrentValue | string | date |\r\n| isForScheduledWorkOnly | RegularAsset->IsForScheduledWorkOnly | boolean | |\r\n| assetTypeId | RegularAsset->AssetType_Id | integer | int64 |\r\n| notes | RegularAsset->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isRunning | Nullable | False | |\r\n| isMsi | Nullable | False | |\r\n| taskRollUpPointId | Nullable | True | RegularAsset->IsMsi eq false |\r\n| calendarId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| generalLedgerId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| costCentreId | Nullable | False | RegularAsset->IsMsi eq true |\r\n| isForScheduledWorkOnly | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateRegularAsset", "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/MatchUpdateRegularAssetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssets/ActiveConditions/{id}": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Get a Regular Asset Active 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 | RegularAssetActiveCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetActiveCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetActiveCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetActiveCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetActiveCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetActiveCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetActiveCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetActiveCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetActiveCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetActiveCondition->PermissionTree_Description | string | |\r\n| id | RegularAssetActiveCondition->Id | integer | int64 |\r\n| conditionId | RegularAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetActiveCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| notes | RegularAssetActiveCondition->Notes | string | |\r\n| recordType | RegularAssetActiveCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetActiveCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetActiveCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetActiveCondition->RegularAsset_Description | string | |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetActiveCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Active Condition", "schema": { "$ref": "#/definitions/GetRegularAssetActiveConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Active Condition" ], "summary": "Update an existing Regular Asset Active 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 | RegularAssetActiveCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetActiveCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetActiveCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Active Condition was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Active Condition" ], "summary": "Delete an existing Regular Asset Active 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 | RegularAssetActiveCondition->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": "DeleteRegularAssetActiveCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetActiveConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Active Condition was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Get a collection of Regular Asset Active 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 | RegularAssetActiveCondition->Id | integer | int64 |\r\n| version | RegularAssetActiveCondition->Version | integer | int32 |\r\n| regularAssetId | RegularAssetActiveCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetActiveCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetActiveCondition->RegularAsset_Description | string | |\r\n| conditionId | RegularAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetActiveConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Active Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetActiveConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Active Condition" ], "summary": "Create a new Regular Asset Active Condition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetActiveCondition->RegularAsset_Id | integer | int64 |\r\n| conditionId | RegularAssetActiveCondition->Condition_Id | integer | int64 |\r\n| notes | RegularAssetActiveCondition->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetActiveCondition", "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/CreateRegularAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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/RegularAssets/{id}/ActiveConditions": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Get a collection of RegularAssetActiveCondition resources for the RegularAsset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetActiveCondition->Id | integer | int64 |\r\n| version | RegularAssetActiveCondition->Version | integer | int32 |\r\n| regularAssetId | RegularAssetActiveCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetActiveCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetActiveCondition->RegularAsset_Description | string | |\r\n| conditionId | RegularAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetActiveConditionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Active Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetActiveConditionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/Lookups/LookupRegularAssetActiveConditionChangePermissionTree": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Lookup the permission set for changing the Regular Asset Active 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": "LookupRegularAssetActiveConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetActiveConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/Lookups/LookupRegularAssetActiveConditionCondition": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Lookup the Condition Type for the Regular Asset Active 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| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupRegularAssetActiveConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetActiveConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/Lookups/LookupRegularAssetActiveConditionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Lookup the permission set for creating the Regular Asset Active 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": "LookupRegularAssetActiveConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetActiveConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/Lookups/LookupRegularAssetActiveConditionRegularAsset": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Lookup the Regular Asset for the Regular Asset Active 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetActiveConditionRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetActiveConditionRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/Batch/{ids}": { "get": { "tags": [ "Regular Asset Active Condition" ], "summary": "Get a collection of Regular Asset Active 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 | RegularAssetActiveCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetActiveCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetActiveCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetActiveCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetActiveCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetActiveCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetActiveCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetActiveCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetActiveCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetActiveCondition->PermissionTree_Description | string | |\r\n| id | RegularAssetActiveCondition->Id | integer | int64 |\r\n| conditionId | RegularAssetActiveCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetActiveCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetActiveCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetActiveCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetActiveCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetActiveCondition->Condition_ConditionType_Description | string | |\r\n| notes | RegularAssetActiveCondition->Notes | string | |\r\n| recordType | RegularAssetActiveCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetActiveCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetActiveCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetActiveCondition->RegularAsset_Description | string | |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetActiveCondition", "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 Active 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 Active Condition collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetActiveConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/Batch": { "post": { "tags": [ "Regular Asset Active Condition" ], "summary": "Create a new collection of Regular Asset Active Condition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetActiveCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetActiveCondition->RegularAsset_Id | integer | int64 |\r\n| conditionId | RegularAssetActiveCondition->Condition_Id | integer | int64 |\r\n| notes | RegularAssetActiveCondition->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetActiveCondition", "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/BatchCreateRegularAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Active 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 Active Condition" ], "summary": "Update a collection of existing Regular Asset Active 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 | RegularAssetActiveCondition->Id | integer | int64 |\r\n| version | RegularAssetActiveCondition->Version | integer | int32 |\r\n| conditionId | RegularAssetActiveCondition->Condition_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetActiveCondition->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetActiveCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| conditionId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetActiveCondition", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetActiveConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Active Condition batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Active Condition" ], "summary": "Delete a collection of existing Regular Asset Active 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 | RegularAssetActiveCondition->Id | integer | int64 |\r\n| version | RegularAssetActiveCondition->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetActiveCondition", "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/BatchDeleteRegularAssetActiveConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Active Condition batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Active Condition" ], "summary": "Change the PermissionTree for an existing Regular Asset Active 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 | RegularAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetActiveCondition->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": "ChangeRegularAssetActiveConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Active Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetActiveConditionPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/ActiveConditions/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Active Condition" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset Active 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 | RegularAssetActiveCondition->Id | integer | int64 |\r\n| version | RegularAssetActiveCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetActiveCondition->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": "BatchChangeRegularAssetActiveConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetActiveConditionPermissionTreeResourceActionRequest" } }, { "$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/RegularAssets/Attributes/{id}": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Get a collection of Regular Asset Attribute resources for the Regular Asset.", "description": "### Response Body\r\n#### 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 | RegularAssetAttribute->InheritedFrom_Id | integer | int64 |\r\n| regularAssetId | RegularAssetAttribute->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetAttribute->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetAttribute->RegularAsset_Description | string | |\r\n| developmentStatus | RegularAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | RegularAssetAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | RegularAssetAttribute->IsHistorical | boolean | |\r\n| unsynchronised | RegularAssetAttribute->Unsynchronised | boolean | |\r\n| isInherited | RegularAssetAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| id | RegularAssetAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n", "operationId": "GetRegularAssetAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Attribute", "schema": { "$ref": "#/definitions/GetRegularAssetAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Attribute" ], "summary": "Update an existing Regular Asset 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 | RegularAssetAttribute->Version | integer | int32 |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Attribute" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetAttribute->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": "DeleteRegularAssetAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/{regularAssetId}/Attributes": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Get a collection of Regular Asset Attribute resources for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetAttribute->Id | integer | int64 |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n| createdOn | RegularAssetAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetAttributeCollectionForRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetId", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetAttributeCollectionForRegularAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetAttribute->Id | integer | int64 |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| regularAssetCode | RegularAssetAttribute->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetAttribute->RegularAsset_Description | string | |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n| createdOn | RegularAssetAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Attribute" ], "summary": "Create a new Regular Asset 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| regularAssetId | RegularAssetAttribute->RegularAsset_Id | integer | int64 |\r\n| attributeId | RegularAssetAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | 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": "CreateRegularAssetAttribute", "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/CreateRegularAssetAttributeResourceActionRequest" } }, { "$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/RegularAssets/Attributes/Lookups/LookupRegularAssetAttributeAllowedValue": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Regular Asset 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": "LookupRegularAssetAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Lookups/LookupRegularAssetAttribute": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Lookup the Attribute for the Regular Asset 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": "LookupRegularAssetAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Lookups/LookupRegularAssetAttributeChangePermissionTree": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Lookups/LookupRegularAssetAttributeInsertPermissionTree": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Lookups/LookupRegularAssetAttributeRegularAsset": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Lookup the Regular Asset Attribute for the Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetAttributeRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetAttributeRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Batch/{ids}": { "get": { "tags": [ "Regular Asset Attribute" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetAttribute->InheritedFrom_Id | integer | int64 |\r\n| regularAssetId | RegularAssetAttribute->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetAttribute->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetAttribute->RegularAsset_Description | string | |\r\n| developmentStatus | RegularAssetAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | RegularAssetAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | RegularAssetAttribute->IsHistorical | boolean | |\r\n| unsynchronised | RegularAssetAttribute->Unsynchronised | boolean | |\r\n| isInherited | RegularAssetAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| id | RegularAssetAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRegularAssetAttribute", "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 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 Attribute collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Batch": { "post": { "tags": [ "Regular Asset Attribute" ], "summary": "Create a new collection of Regular Asset 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| regularAssetId | RegularAssetAttribute->RegularAsset_Id | integer | int64 |\r\n| attributeId | RegularAssetAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | 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": "BatchCreateRegularAssetAttribute", "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/BatchCreateRegularAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Attribute" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetAttribute->Id | integer | int64 |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| value | RegularAssetAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdateRegularAssetAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Attribute" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetAttribute->Id | integer | int64 |\r\n| version | RegularAssetAttribute->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": "BatchDeleteRegularAssetAttribute", "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/BatchDeleteRegularAssetAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Attribute" ], "summary": "Accept the Development Status for an existing Regular Asset Attribute resource.", "description": "", "operationId": "AcceptRegularAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Attribute" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Attribute resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Attribute" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Attribute resource id's.", "description": "", "operationId": "BatchRejectRegularAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/{id}/Active": { "patch": { "tags": [ "Regular Asset Attribute" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetAttribute->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": "ChangeRegularAssetAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetAttributeIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Attribute" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetAttribute->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": "ChangeRegularAssetAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetAttributePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Attribute" ], "summary": "Reject the Development Status for an existing Regular Asset Attribute resource.", "description": "", "operationId": "RejectRegularAssetAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Attributes/Batch/Active": { "patch": { "tags": [ "Regular Asset Attribute" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetAttribute->Id | integer | int64 |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetAttribute->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": "BatchChangeRegularAssetAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetAttributeIsActiveResourceActionRequest" } }, { "$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/RegularAssets/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetAttribute->Id | integer | int64 |\r\n| version | RegularAssetAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetAttribute->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": "BatchChangeRegularAssetAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetAttributePermissionTreeResourceActionRequest" } }, { "$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/RegularAssetComponents/{id}": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Get a Regular Asset 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| ruleEvaluationFailedReason | RegularAssetComponent->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetComponent->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetComponent->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | RegularAssetComponent->Unsubscribed | boolean | |\r\n| code | RegularAssetComponent->Code | string | |\r\n| createdByUserId | RegularAssetComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetComponent->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetComponent->ModifiedOn | string | date-time |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetComponent->PermissionTree_Description | string | |\r\n| assetId | RegularAssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetComponent->Asset_Code | string | |\r\n| assetRecordType | RegularAssetComponent->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetDescription | RegularAssetComponent->Asset_Description | string | |\r\n| assetAssetTypeId | RegularAssetComponent->Asset_AssetType_Id | integer | int64 |\r\n| assetAssetTypeRecordType | RegularAssetComponent->Asset_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTreePathId | RegularAssetComponent->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | RegularAssetComponent->Asset_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetComponent->Id | integer | int64 |\r\n| isActive | RegularAssetComponent->IsActive | boolean | |\r\n| isHistorical | RegularAssetComponent->IsHistorical | boolean | |\r\n| isInherited | RegularAssetComponent->IsInherited | boolean | |\r\n| isProposed | RegularAssetComponent->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetComponent->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | RegularAssetComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | RegularAssetComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | RegularAssetComponent->ParentComponent_Description | string | |\r\n| recordType | RegularAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| siteId | RegularAssetComponent->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetComponent->Site_Code | string | |\r\n| siteDescription | RegularAssetComponent->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetComponent->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetComponent->Unsynchronised | boolean | |\r\n| treePathId | RegularAssetComponent->TreePathId | integer | int64 |\r\n| treePathItems | RegularAssetComponent->TreePathItems | array | array |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetComponent->AssetImportance_Description | string | |\r\n| assetTypeId | RegularAssetComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetComponent->AssetType_Description | string | |\r\n| barcode | RegularAssetComponent->Barcode | string | |\r\n| commissionedOn | RegularAssetComponent->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | RegularAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | RegularAssetComponent->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | RegularAssetComponent->CommissioningWorkOrder_Description | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| inheritedFromId | RegularAssetComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetComponent->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromRulesLastChangedOn | RegularAssetComponent->InheritedFrom_RulesLastChangedOn | string | date-time |\r\n| materialMasterId | RegularAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetComponent->MaterialMaster_Description | string | |\r\n| notes | RegularAssetComponent->Notes | string | |\r\n| partNumber | RegularAssetComponent->PartNumber | string | |\r\n| qRCode | RegularAssetComponent->QRCode | string | |\r\n| quantity | RegularAssetComponent->Quantity | integer | int32 |\r\n| rFId | RegularAssetComponent->RFId | string | |\r\n| serialNumber | RegularAssetComponent->SerialNumber | string | |\r\n| specification | RegularAssetComponent->Specification | string | |\r\n| supplierId | RegularAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetComponent->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetComponent->Supplier_Description | string | |\r\n| supplierPartNumber | RegularAssetComponent->SupplierPartNumber | string | |\r\n| warranty | RegularAssetComponent->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "GetRegularAssetComponent", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Component", "schema": { "$ref": "#/definitions/GetRegularAssetComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Component" ], "summary": "Update an existing Regular Asset 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 | RegularAssetComponent->Version | integer | int32 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| quantity | RegularAssetComponent->Quantity | integer | int32 |\r\n| partNumber | RegularAssetComponent->PartNumber | string | |\r\n| qRCode | RegularAssetComponent->QRCode | string | |\r\n| rFId | RegularAssetComponent->RFId | string | |\r\n| specification | RegularAssetComponent->Specification | string | |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| supplierId | RegularAssetComponent->Supplier_Id | integer | int64 |\r\n| materialMasterId | RegularAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetComponent->SupplierPartNumber | string | |\r\n| assetImportanceId | RegularAssetComponent->AssetImportance_Id | integer | int64 |\r\n| barcode | RegularAssetComponent->Barcode | string | |\r\n| serialNumber | RegularAssetComponent->SerialNumber | string | |\r\n| commissionedOn | RegularAssetComponent->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | RegularAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| notes | RegularAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | RegularAssetComponent->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 | RegularAssetComponent->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| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 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": "UpdateRegularAssetComponent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Component" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetComponent->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": "DeleteRegularAssetComponent", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Component 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/RegularAssetComponents": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| isActive | RegularAssetComponent->IsActive | boolean | |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| partNumber | RegularAssetComponent->PartNumber | string | |\r\n| qRCode | RegularAssetComponent->QRCode | string | |\r\n| rFId | RegularAssetComponent->RFId | string | |\r\n| specification | RegularAssetComponent->Specification | string | |\r\n| supplierPartNumber | RegularAssetComponent->SupplierPartNumber | string | |\r\n| commissionedOn | RegularAssetComponent->CommissionedOn | string | date |\r\n| recordType | RegularAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| quantity | RegularAssetComponent->Quantity | integer | int32 |\r\n| assetImportanceId | RegularAssetComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetComponent->AssetImportance_Description | string | |\r\n| siteId | RegularAssetComponent->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetComponent->Site_Code | string | |\r\n| siteDescription | RegularAssetComponent->Site_Description | string | |\r\n| commissioningWorkOrderId | RegularAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | RegularAssetComponent->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | RegularAssetComponent->CommissioningWorkOrder_Description | string | |\r\n| assetTypeId | RegularAssetComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetComponent->AssetType_Description | string | |\r\n| assetId | RegularAssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetComponent->Asset_Code | string | |\r\n| assetDescription | RegularAssetComponent->Asset_Description | string | |\r\n| assetTreePathItems | RegularAssetComponent->Asset_TreePathItems | array | array |\r\n| parentComponentId | RegularAssetComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | RegularAssetComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | RegularAssetComponent->ParentComponent_Description | string | |\r\n| supplierId | RegularAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetComponent->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetComponent->Supplier_Description | string | |\r\n| materialMasterId | RegularAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetComponent->MaterialMaster_Description | string | |\r\n| developmentStatus | RegularAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetComponent->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetComponent->InheritedFrom_Id | integer | int64 |\r\n| isHistorical | RegularAssetComponent->IsHistorical | boolean | |\r\n| notes | RegularAssetComponent->Notes | string | |\r\n| rulesLastEvaluatedOn | RegularAssetComponent->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | RegularAssetComponent->RuleEvaluationPassed | boolean | |\r\n| createdOn | RegularAssetComponent->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetComponent->ModifiedOn | string | date-time |\r\n| treePathItems | RegularAssetComponent->TreePathItems | array | array |\r\n", "operationId": "GetRegularAssetComponentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Component collection", "schema": { "$ref": "#/definitions/GetRegularAssetComponentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Component" ], "summary": "Create a new Regular Asset 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| assetId | RegularAssetComponent->Asset_Id | integer | int64 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| permissionTreeId | RegularAssetComponent->PermissionTree_Id | integer | int64 |\r\n| siteId | RegularAssetComponent->Site_Id | integer | int64 |\r\n| parentComponentId | RegularAssetComponent->ParentComponent_Id | integer | int64 |\r\n| quantity | RegularAssetComponent->Quantity | integer | int32 |\r\n| partNumber | RegularAssetComponent->PartNumber | string | |\r\n| qRCode | RegularAssetComponent->QRCode | string | |\r\n| rFId | RegularAssetComponent->RFId | string | |\r\n| specification | RegularAssetComponent->Specification | string | |\r\n| supplierId | RegularAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetComponent->SupplierPartNumber | string | |\r\n| commissionedOn | RegularAssetComponent->CommissionedOn | string | date |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| assetImportanceId | RegularAssetComponent->AssetImportance_Id | integer | int64 |\r\n| materialMasterId | RegularAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| barcode | RegularAssetComponent->Barcode | string | |\r\n| serialNumber | RegularAssetComponent->SerialNumber | string | |\r\n| notes | RegularAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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| 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| siteId | System Generated | true | If no value specified |\r\n| siteId | Nullable | False | |\r\n| parentComponentId | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 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": "CreateRegularAssetComponent", "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/CreateRegularAssetComponentResourceActionRequest" } }, { "$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/RegularAssetComponents/Lookups/LookupAssetComponentParentComponent": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the Regular Asset Component for the Regular Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| recordType | AssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAssetComponentParentComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/AssetComponentParentComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentAsset": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the Asset for the Regular Asset 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 | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupRegularAssetComponentAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/RegularAssetComponentAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentChangePermissionTree": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetComponentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentCommissioningWorkOrder": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the Work Order for the Regular Asset 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 | WorkOrder->Id | integer | int64 |\r\n| code | WorkOrder->Code | string | |\r\n| description | WorkOrder->Description | string | |\r\n", "operationId": "LookupRegularAssetComponentCommissioningWorkOrder", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Work Order collection", "schema": { "$ref": "#/definitions/RegularAssetComponentCommissioningWorkOrderLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentImportance": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the Asset Importance for the Regular Asset 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": "LookupRegularAssetComponentImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetComponentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentMaterialMaster": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the Material Master for the Regular Asset 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": "LookupRegularAssetComponentMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentsMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentSite": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the Site for the Regular Asset 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupRegularAssetComponentSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/RegularAssetComponentsSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Lookups/LookupRegularAssetComponentSupplier": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Lookup the Supplier for the Regular Asset 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": "LookupRegularAssetComponentSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Component" ], "summary": "Get a collection of Regular Asset 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| ruleEvaluationFailedReason | RegularAssetComponent->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetComponent->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetComponent->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | RegularAssetComponent->Unsubscribed | boolean | |\r\n| code | RegularAssetComponent->Code | string | |\r\n| createdByUserId | RegularAssetComponent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetComponent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetComponent->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetComponent->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetComponent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetComponent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetComponent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetComponent->ModifiedOn | string | date-time |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetComponent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetComponent->PermissionTree_Description | string | |\r\n| assetId | RegularAssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetComponent->Asset_Code | string | |\r\n| assetRecordType | RegularAssetComponent->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetDescription | RegularAssetComponent->Asset_Description | string | |\r\n| assetAssetTypeId | RegularAssetComponent->Asset_AssetType_Id | integer | int64 |\r\n| assetAssetTypeRecordType | RegularAssetComponent->Asset_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetTreePathId | RegularAssetComponent->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | RegularAssetComponent->Asset_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetComponent->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetComponent->Id | integer | int64 |\r\n| isActive | RegularAssetComponent->IsActive | boolean | |\r\n| isHistorical | RegularAssetComponent->IsHistorical | boolean | |\r\n| isInherited | RegularAssetComponent->IsInherited | boolean | |\r\n| isProposed | RegularAssetComponent->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetComponent->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetComponent->LastConfirmedOn | string | date-time |\r\n| parentComponentId | RegularAssetComponent->ParentComponent_Id | integer | int64 |\r\n| parentComponentCode | RegularAssetComponent->ParentComponent_Code | string | |\r\n| parentComponentDescription | RegularAssetComponent->ParentComponent_Description | string | |\r\n| recordType | RegularAssetComponent->RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| siteId | RegularAssetComponent->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetComponent->Site_Code | string | |\r\n| siteDescription | RegularAssetComponent->Site_Description | string | |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetComponent->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetComponent->Unsynchronised | boolean | |\r\n| treePathId | RegularAssetComponent->TreePathId | integer | int64 |\r\n| treePathItems | RegularAssetComponent->TreePathItems | array | array |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| assetImportanceId | RegularAssetComponent->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RegularAssetComponent->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RegularAssetComponent->AssetImportance_Description | string | |\r\n| assetTypeId | RegularAssetComponent->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetComponent->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetComponent->AssetType_Description | string | |\r\n| barcode | RegularAssetComponent->Barcode | string | |\r\n| commissionedOn | RegularAssetComponent->CommissionedOn | string | date |\r\n| commissioningWorkOrderId | RegularAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| commissioningWorkOrderCode | RegularAssetComponent->CommissioningWorkOrder_Code | string | |\r\n| commissioningWorkOrderDescription | RegularAssetComponent->CommissioningWorkOrder_Description | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| inheritedFromId | RegularAssetComponent->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetComponent->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromRulesLastChangedOn | RegularAssetComponent->InheritedFrom_RulesLastChangedOn | string | date-time |\r\n| materialMasterId | RegularAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetComponent->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetComponent->MaterialMaster_Description | string | |\r\n| notes | RegularAssetComponent->Notes | string | |\r\n| partNumber | RegularAssetComponent->PartNumber | string | |\r\n| qRCode | RegularAssetComponent->QRCode | string | |\r\n| quantity | RegularAssetComponent->Quantity | integer | int32 |\r\n| rFId | RegularAssetComponent->RFId | string | |\r\n| serialNumber | RegularAssetComponent->SerialNumber | string | |\r\n| specification | RegularAssetComponent->Specification | string | |\r\n| supplierId | RegularAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetComponent->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetComponent->Supplier_Description | string | |\r\n| supplierPartNumber | RegularAssetComponent->SupplierPartNumber | string | |\r\n| warranty | RegularAssetComponent->Warranty | string (Allowed values: [Strict, NonStrict, Expired]) | enum |\r\n", "operationId": "BatchGetRegularAssetComponent", "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 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 Component collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetComponentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Batch": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Create a new collection of Regular Asset 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| assetId | RegularAssetComponent->Asset_Id | integer | int64 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| permissionTreeId | RegularAssetComponent->PermissionTree_Id | integer | int64 |\r\n| siteId | RegularAssetComponent->Site_Id | integer | int64 |\r\n| parentComponentId | RegularAssetComponent->ParentComponent_Id | integer | int64 |\r\n| quantity | RegularAssetComponent->Quantity | integer | int32 |\r\n| partNumber | RegularAssetComponent->PartNumber | string | |\r\n| qRCode | RegularAssetComponent->QRCode | string | |\r\n| rFId | RegularAssetComponent->RFId | string | |\r\n| specification | RegularAssetComponent->Specification | string | |\r\n| supplierId | RegularAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetComponent->SupplierPartNumber | string | |\r\n| commissionedOn | RegularAssetComponent->CommissionedOn | string | date |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| assetImportanceId | RegularAssetComponent->AssetImportance_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| barcode | RegularAssetComponent->Barcode | string | |\r\n| serialNumber | RegularAssetComponent->SerialNumber | string | |\r\n| materialMasterId | RegularAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| notes | RegularAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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| 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| siteId | System Generated | true | If no value specified |\r\n| siteId | Nullable | False | |\r\n| parentComponentId | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 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": "BatchCreateRegularAssetComponent", "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/BatchCreateRegularAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Component" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n| alternativeDescription | RegularAssetComponent->AlternativeDescription | string | |\r\n| quantity | RegularAssetComponent->Quantity | integer | int32 |\r\n| partNumber | RegularAssetComponent->PartNumber | string | |\r\n| qRCode | RegularAssetComponent->QRCode | string | |\r\n| rFId | RegularAssetComponent->RFId | string | |\r\n| specification | RegularAssetComponent->Specification | string | |\r\n| sequenceNumber | RegularAssetComponent->SequenceNumber | integer | int32 |\r\n| supplierId | RegularAssetComponent->Supplier_Id | integer | int64 |\r\n| supplierPartNumber | RegularAssetComponent->SupplierPartNumber | string | |\r\n| commissionedOn | RegularAssetComponent->CommissionedOn | string | date |\r\n| assetImportanceId | RegularAssetComponent->AssetImportance_Id | integer | int64 |\r\n| commissioningWorkOrderId | RegularAssetComponent->CommissioningWorkOrder_Id | integer | int64 |\r\n| serialNumber | RegularAssetComponent->SerialNumber | string | |\r\n| barcode | RegularAssetComponent->Barcode | string | |\r\n| materialMasterId | RegularAssetComponent->MaterialMaster_Id | integer | int64 |\r\n| notes | RegularAssetComponent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| code | Nullable | False | |\r\n| code | Read-only | True | RegularAssetComponent->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 | RegularAssetComponent->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| qRCode | Min Length | >= 1 chars| |\r\n| qRCode | Max Length | <= 200 chars| |\r\n| rFId | Min Length | >= 1 chars| |\r\n| rFId | Max Length | <= 200 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| serialNumber | Min Length | >= 1 chars| |\r\n| serialNumber | Max Length | <= 50 chars| |\r\n| barcode | Min Length | >= 1 chars| |\r\n| barcode | Max Length | <= 900 chars| |\r\n\r\n", "operationId": "BatchUpdateRegularAssetComponent", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Component" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| version | RegularAssetComponent->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": "BatchDeleteRegularAssetComponent", "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/BatchDeleteRegularAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Component 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/RegularAssetComponents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Accept the Development Status for an existing Regular Asset Component resource.", "description": "", "operationId": "AcceptRegularAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Component resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Component resource id's.", "description": "", "operationId": "BatchRejectRegularAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Batch/{ids}/Sync": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Synchronise the collection of existing Regular Asset Component resource id's.", "description": "", "operationId": "BatchSyncRegularAssetComponent", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/{id}/Active": { "patch": { "tags": [ "Regular Asset Component" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetComponent->Version | integer | int32 |\r\n| isActive | RegularAssetComponent->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": "ChangeRegularAssetComponentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetComponents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Component" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponent->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": "ChangeRegularAssetComponentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetComponents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Reject the Development Status for an existing Regular Asset Component resource.", "description": "", "operationId": "RejectRegularAssetComponentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Sync/Resubscribe": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Accept the Development Status for an existing Regular Asset 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| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "ResubscribeRegularAssetComponentDevelopmentStatus", "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/ResubscribeRegularAssetComponentDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/{id}/Sync": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Synchronise the existing Regular Asset Component resource.", "description": "", "operationId": "SyncRegularAssetComponent", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Sync/Unsubscribe": { "post": { "tags": [ "Regular Asset Component" ], "summary": "Accept the Development Status for an existing Regular Asset 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| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "UnsubscribeRegularAssetComponentDevelopmentStatus", "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/UnsubscribeRegularAssetComponentDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Batch/Active": { "patch": { "tags": [ "Regular Asset Component" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| isActive | RegularAssetComponent->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": "BatchChangeRegularAssetComponentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetComponentIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetComponents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Component" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponent->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": "BatchChangeRegularAssetComponentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetComponentPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetComponents/MatchBatch": { "patch": { "tags": [ "Regular Asset Component" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| version | RegularAssetComponent->Version | integer | int32 |\r\n| quantity | RegularAssetComponent->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| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdateRegularAssetComponent", "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/MatchUpdateRegularAssetComponentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetComponents/Attributes/{id}": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Get a collection of Regular Asset Component Attribute resources for the Regular Asset 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 | RegularAssetComponentAttribute->InheritedFrom_Id | integer | int64 |\r\n| regularAssetComponentId | RegularAssetComponentAttribute->RegularAssetComponent_Id | integer | int64 |\r\n| regularAssetComponentCode | RegularAssetComponentAttribute->RegularAssetComponent_Code | string | |\r\n| regularAssetComponentDescription | RegularAssetComponentAttribute->RegularAssetComponent_Description | string | |\r\n| developmentStatus | RegularAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | RegularAssetComponentAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetComponentAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetComponentAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetComponentAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | RegularAssetComponentAttribute->IsHistorical | boolean | |\r\n| unsynchronised | RegularAssetComponentAttribute->Unsynchronised | boolean | |\r\n| isInherited | RegularAssetComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetComponentAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| id | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n", "operationId": "GetRegularAssetComponentAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Component Attribute", "schema": { "$ref": "#/definitions/GetRegularAssetComponentAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Update an existing Regular Asset 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 | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetComponentAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetComponentAttribute->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": "DeleteRegularAssetComponentAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Component Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/{regularAssetComponentId}/Attributes": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Get a collection of Regular Asset Component Attribute resources for the Regular Asset 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 | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetComponentAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n| createdOn | RegularAssetComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetComponentAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetComponentAttributeCollectionForRegularAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetComponentId", "in": "path", "required": true, "description": "Regular Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Component Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetComponentAttributeCollectionForRegularAssetComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetComponentAttribute->IsInherited | boolean | |\r\n| regularAssetComponentCode | RegularAssetComponentAttribute->RegularAssetComponent_Code | string | |\r\n| attributeId | RegularAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n| createdOn | RegularAssetComponentAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetComponentAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetComponentAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Component Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetComponentAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Create a new Regular Asset 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| regularAssetComponentId | RegularAssetComponentAttribute->RegularAssetComponent_Id | integer | int64 |\r\n| attributeId | RegularAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetComponentId | Required | True | |\r\n| regularAssetComponentId | 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": "CreateRegularAssetComponentAttribute", "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/CreateRegularAssetComponentAttributeResourceActionRequest" } }, { "$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/RegularAssetComponents/Attributes/Lookups/LookupRegularAssetComponentAttributeAllowedValue": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Regular Asset 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": "LookupRegularAssetComponentAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Lookups/LookupRegularAssetComponentAttribute": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Lookup the Attribute for the Regular Asset 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": "LookupRegularAssetComponentAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Lookups/LookupRegularAssetComponentAttributeChangePermissionTree": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetComponentAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Lookups/LookupRegularAssetComponentAttributeInsertPermissionTree": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetComponentAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Lookups/LookupRegularAssetComponentAttributeRegularAssetComponent": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Lookup the Regular Asset Component Attribute for the Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n", "operationId": "LookupRegularAssetComponentAttributeRegularAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Component collection", "schema": { "$ref": "#/definitions/RegularAssetComponentAttributeRegularAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Batch/{ids}": { "get": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetComponentAttribute->InheritedFrom_Id | integer | int64 |\r\n| regularAssetComponentId | RegularAssetComponentAttribute->RegularAssetComponent_Id | integer | int64 |\r\n| regularAssetComponentCode | RegularAssetComponentAttribute->RegularAssetComponent_Code | string | |\r\n| regularAssetComponentDescription | RegularAssetComponentAttribute->RegularAssetComponent_Description | string | |\r\n| developmentStatus | RegularAssetComponentAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | RegularAssetComponentAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetComponentAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetComponentAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetComponentAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | RegularAssetComponentAttribute->IsHistorical | boolean | |\r\n| unsynchronised | RegularAssetComponentAttribute->Unsynchronised | boolean | |\r\n| isInherited | RegularAssetComponentAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetComponentAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetComponentAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetComponentAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetComponentAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetComponentAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetComponentAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetComponentAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetComponentAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetComponentAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetComponentAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetComponentAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| id | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetComponentAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetComponentAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetComponentAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetComponentAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetComponentAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetComponentAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetComponentAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRegularAssetComponentAttribute", "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 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 Component Attribute collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetComponentAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Batch": { "post": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Create a new collection of Regular Asset 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| regularAssetComponentId | RegularAssetComponentAttribute->RegularAssetComponent_Id | integer | int64 |\r\n| attributeId | RegularAssetComponentAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetComponentAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetComponentId | Required | True | |\r\n| regularAssetComponentId | 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": "BatchCreateRegularAssetComponentAttribute", "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/BatchCreateRegularAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Component Attribute" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| value | RegularAssetComponentAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetComponentAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetComponentAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdateRegularAssetComponentAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetComponentAttribute->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": "BatchDeleteRegularAssetComponentAttribute", "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/BatchDeleteRegularAssetComponentAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Component Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Accept the Development Status for an existing Regular Asset Component Attribute resource.", "description": "", "operationId": "AcceptRegularAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Component Attribute resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Component Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Component Attribute resource id's.", "description": "", "operationId": "BatchRejectRegularAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Component Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/{id}/Active": { "patch": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetComponentAttribute->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": "ChangeRegularAssetComponentAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetComponentAttributeIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponentAttribute->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": "ChangeRegularAssetComponentAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetComponentAttributePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Reject the Development Status for an existing Regular Asset Component Attribute resource.", "description": "", "operationId": "RejectRegularAssetComponentAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Attributes/Batch/Active": { "patch": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetComponentAttribute->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": "BatchChangeRegularAssetComponentAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetComponentAttributeIsActiveResourceActionRequest" } }, { "$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/RegularAssetComponents/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Component Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetComponentAttribute->Id | integer | int64 |\r\n| version | RegularAssetComponentAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponentAttribute->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": "BatchChangeRegularAssetComponentAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetComponentAttributePermissionTreeResourceActionRequest" } }, { "$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/RegularAssetComponents/Documents/{id}": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Get a collection of Regular Asset Component Document resources for the Regular Asset 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 | RegularAssetComponentDocument->InheritedFrom_Id | integer | int64 |\r\n| regularAssetComponentId | RegularAssetComponentDocument->RegularAssetComponent_Id | integer | int64 |\r\n| regularAssetComponentCode | RegularAssetComponentDocument->RegularAssetComponent_Code | string | |\r\n| regularAssetComponentDescription | RegularAssetComponentDocument->RegularAssetComponent_Description | string | |\r\n| developmentStatus | RegularAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | RegularAssetComponentDocument->IsHistorical | boolean | |\r\n| isInherited | RegularAssetComponentDocument->IsInherited | boolean | |\r\n| isProposed | RegularAssetComponentDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetComponentDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetComponentDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetComponentDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetComponentDocument->Unsynchronised | boolean | |\r\n| isActive | RegularAssetComponentDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetComponentDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetComponentDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetComponentDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetComponentDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Component Document", "schema": { "$ref": "#/definitions/GetRegularAssetComponentDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Component Document" ], "summary": "Update an existing Regular Asset 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 | RegularAssetComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetComponentDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Component Document" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetComponentDocument->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": "DeleteRegularAssetComponentDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Component 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/RegularAssetComponents/{id}/Documents": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Get a collection of Regular Asset Component Document resources for the Regular Asset 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 | RegularAssetComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetComponentDocument->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetComponentDocument->InheritedFrom_Id | integer | int64 |\r\n| documentRecordId | RegularAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n| createdOn | RegularAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetComponentDocumentCollectionForRegularAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Component Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetComponentDocumentCollectionForRegularAssetComponentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetComponentDocument->Version | integer | int32 |\r\n| regularAssetComponentCode | RegularAssetComponentDocument->RegularAssetComponent_Code | string | |\r\n| regularAssetComponentDescription | RegularAssetComponentDocument->RegularAssetComponent_Description | string | |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetComponentDocument->IsInherited | boolean | |\r\n| documentRecordId | RegularAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n| createdOn | RegularAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetComponentDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetComponentDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Component Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetComponentDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Component Document" ], "summary": "Create a new Regular Asset 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| regularAssetComponentId | RegularAssetComponentDocument->RegularAssetComponent_Id | integer | int64 |\r\n| documentRecordId | RegularAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetComponentId | Required | True | |\r\n| regularAssetComponentId | 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": "CreateRegularAssetComponentDocument", "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/CreateRegularAssetComponentDocumentResourceActionRequest" } }, { "$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/RegularAssetComponents/Documents/Lookups/LookupRegularAssetComponentDocumentChangePermissionTree": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetComponentDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Lookups/LookupRegularAssetComponentDocument": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Lookup the for the Regular Asset 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": "LookupRegularAssetComponentDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Lookups/LookupRegularAssetComponentDocumentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetComponentDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Lookups/LookupRegularAssetComponentDocumentRegularAssetComponent": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Lookup the Regular Asset Component Document for the Regular Asset 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 | RegularAssetComponent->Id | integer | int64 |\r\n| code | RegularAssetComponent->Code | string | |\r\n| description | RegularAssetComponent->Description | string | |\r\n", "operationId": "LookupRegularAssetComponentDocumentRegularAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Component collection", "schema": { "$ref": "#/definitions/RegularAssetComponentDocumentRegularAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Component Document" ], "summary": "Get a collection of Regular Asset 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| inheritedFromId | RegularAssetComponentDocument->InheritedFrom_Id | integer | int64 |\r\n| regularAssetComponentId | RegularAssetComponentDocument->RegularAssetComponent_Id | integer | int64 |\r\n| regularAssetComponentCode | RegularAssetComponentDocument->RegularAssetComponent_Code | string | |\r\n| regularAssetComponentDescription | RegularAssetComponentDocument->RegularAssetComponent_Description | string | |\r\n| developmentStatus | RegularAssetComponentDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | RegularAssetComponentDocument->IsHistorical | boolean | |\r\n| isInherited | RegularAssetComponentDocument->IsInherited | boolean | |\r\n| isProposed | RegularAssetComponentDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetComponentDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetComponentDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetComponentDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetComponentDocument->Unsynchronised | boolean | |\r\n| isActive | RegularAssetComponentDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetComponentDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetComponentDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetComponentDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetComponentDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetComponentDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetComponentDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetComponentDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetComponentDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetComponentDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetComponentDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetComponentDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetComponentDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetComponentDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetComponentDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetComponentDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetComponentDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetComponentDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetComponentDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetComponentDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetComponentDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetComponentDocument", "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 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 Component Document collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetComponentDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Batch": { "post": { "tags": [ "Regular Asset Component Document" ], "summary": "Create a new collection of Regular Asset 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| regularAssetComponentId | RegularAssetComponentDocument->RegularAssetComponent_Id | integer | int64 |\r\n| documentRecordId | RegularAssetComponentDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetComponentDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetComponentId | Required | True | |\r\n| regularAssetComponentId | 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": "BatchCreateRegularAssetComponentDocument", "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/BatchCreateRegularAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Component Document" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetComponentDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetComponentDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetComponentDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdateRegularAssetComponentDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Component Document" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetComponentDocument->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": "BatchDeleteRegularAssetComponentDocument", "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/BatchDeleteRegularAssetComponentDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Component 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/RegularAssetComponents/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Component Document" ], "summary": "Accept the Development Status for an existing Regular Asset Component Document resource.", "description": "", "operationId": "AcceptRegularAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Component Document" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Component Document resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Component Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Component Document" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Component Document resource id's.", "description": "", "operationId": "BatchRejectRegularAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Component Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/{id}/Active": { "patch": { "tags": [ "Regular Asset Component Document" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetComponentDocument->Version | integer | int32 |\r\n| isActive | RegularAssetComponentDocument->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": "ChangeRegularAssetComponentDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetComponentDocumentIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Component Document" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponentDocument->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": "ChangeRegularAssetComponentDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetComponentDocumentPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Component Document" ], "summary": "Reject the Development Status for an existing Regular Asset Component Document resource.", "description": "", "operationId": "RejectRegularAssetComponentDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Component Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetComponents/Documents/Batch/Active": { "patch": { "tags": [ "Regular Asset Component Document" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetComponentDocument->Version | integer | int32 |\r\n| isActive | RegularAssetComponentDocument->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": "BatchChangeRegularAssetComponentDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetComponentDocumentIsActiveResourceActionRequest" } }, { "$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/RegularAssetComponents/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Component Document" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetComponentDocument->Id | integer | int64 |\r\n| version | RegularAssetComponentDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetComponentDocument->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": "BatchChangeRegularAssetComponentDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetComponentDocumentPermissionTreeResourceActionRequest" } }, { "$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/RegularAssets/Conditions/{id}": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetCondition->Id | integer | int64 |\r\n| isActive | RegularAssetCondition->IsActive | boolean | |\r\n| isHistorical | RegularAssetCondition->IsHistorical | boolean | |\r\n| isInherited | RegularAssetCondition->IsInherited | boolean | |\r\n| isProposed | RegularAssetCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetCondition->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetCondition->PermissionTree_Description | string | |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromConditionId | RegularAssetCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | RegularAssetCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | RegularAssetCondition->InheritedFrom_Condition_Description | string | |\r\n| inheritedFromConditionConditionTypeId | RegularAssetCondition->InheritedFrom_Condition_ConditionType_Id | integer | int64 |\r\n| inheritedFromConditionConditionTypeCode | RegularAssetCondition->InheritedFrom_Condition_ConditionType_Code | string | |\r\n| inheritedFromConditionConditionTypeDescription | RegularAssetCondition->InheritedFrom_Condition_ConditionType_Description | string | |\r\n| notes | RegularAssetCondition->Notes | string | |\r\n| recordType | RegularAssetCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetCondition->RegularAsset_Description | string | |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetRegularAssetCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Condition", "schema": { "$ref": "#/definitions/GetRegularAssetConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Condition" ], "summary": "Update an existing Regular Asset 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 | RegularAssetCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | RegularAssetCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| adjustmentFactor | Nullable | False | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Condition was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Condition" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetCondition->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": "DeleteRegularAssetCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Condition was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetCondition->Id | integer | int64 |\r\n| version | RegularAssetCondition->Version | integer | int32 |\r\n| regularAssetId | RegularAssetCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetCondition->RegularAsset_Description | string | |\r\n| conditionId | RegularAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetCondition->Condition_ConditionType_Description | string | |\r\n| sequenceNumber | RegularAssetCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isActive | RegularAssetCondition->IsActive | boolean | |\r\n| developmentStatus | RegularAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetCondition->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Condition" ], "summary": "Create a new Regular Asset Condition resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetCondition->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetCondition->RegularAsset_Id | integer | int64 |\r\n| inheritedFromId | RegularAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetCondition->Condition_Id | integer | int64 |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | RegularAssetCondition->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| inheritedFromId | Min Value | >= 0| |\r\n| adjustmentFactor | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetCondition", "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/CreateRegularAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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/RegularAssets/{id}/Conditions": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Get a collection of RegularAssetCondition resources for the RegularAsset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetCondition->Id | integer | int64 |\r\n| version | RegularAssetCondition->Version | integer | int32 |\r\n| regularAssetId | RegularAssetCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetCondition->RegularAsset_Description | string | |\r\n| conditionId | RegularAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeCode | RegularAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetCondition->Condition_ConditionType_Description | string | |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isInherited | RegularAssetCondition->IsInherited | boolean | |\r\n| isActive | RegularAssetCondition->IsActive | boolean | |\r\n| developmentStatus | RegularAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n", "operationId": "GetRegularAssetConditionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetConditionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Lookups/LookupRegularAssetConditionChangePermissionTree": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Lookups/LookupRegularAssetConditionCondition": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Lookup the Condition for the Regular Asset 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| conditionTypeId | Condition->ConditionType_Id | integer | int64 |\r\n| conditionTypeCode | Condition->ConditionType_Code | string | |\r\n| conditionTypeDescription | Condition->ConditionType_Description | string | |\r\n", "operationId": "LookupRegularAssetConditionCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConditionConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Lookups/LookupRegularAssetConditionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Lookups/LookupRegularAssetConditionRegularAsset": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Lookup the Regular Asset for the Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetConditionRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetConditionRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Batch/{ids}": { "get": { "tags": [ "Regular Asset Condition" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetCondition->Id | integer | int64 |\r\n| isActive | RegularAssetCondition->IsActive | boolean | |\r\n| isHistorical | RegularAssetCondition->IsHistorical | boolean | |\r\n| isInherited | RegularAssetCondition->IsInherited | boolean | |\r\n| isProposed | RegularAssetCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetCondition->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetCondition->PermissionTree_Description | string | |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromConditionId | RegularAssetCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | RegularAssetCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | RegularAssetCondition->InheritedFrom_Condition_Description | string | |\r\n| inheritedFromConditionConditionTypeId | RegularAssetCondition->InheritedFrom_Condition_ConditionType_Id | integer | int64 |\r\n| inheritedFromConditionConditionTypeCode | RegularAssetCondition->InheritedFrom_Condition_ConditionType_Code | string | |\r\n| inheritedFromConditionConditionTypeDescription | RegularAssetCondition->InheritedFrom_Condition_ConditionType_Description | string | |\r\n| notes | RegularAssetCondition->Notes | string | |\r\n| recordType | RegularAssetCondition->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetCondition->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetCondition->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetCondition->RegularAsset_Description | string | |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetRegularAssetCondition", "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 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 Condition collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Batch": { "post": { "tags": [ "Regular Asset Condition" ], "summary": "Create a new collection of Regular Asset Condition resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetCondition->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetCondition->RegularAsset_Id | integer | int64 |\r\n| inheritedFromId | RegularAssetCondition->InheritedFrom_Id | integer | int64 |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetCondition->Condition_Id | integer | int64 |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | RegularAssetCondition->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| inheritedFromId | Min Value | >= 0| |\r\n| adjustmentFactor | Nullable | False | |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | Required | True | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetCondition", "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/BatchCreateRegularAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 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 Condition" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetCondition->Id | integer | int64 |\r\n| version | RegularAssetCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetCondition->AdjustmentFactor | number | decimal |\r\n| state | RegularAssetCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | RegularAssetCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| adjustmentFactor | Nullable | False | |\r\n| state | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetCondition", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetConditionResourceActionRequest" } }, { "type": "boolean", "name": "applyToTaskConditions", "in": "query", "description": "Apply the changes to the Regular Asset Task Conditions (default=False)", "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 Condition batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Condition" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetCondition->Id | integer | int64 |\r\n| version | RegularAssetCondition->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetCondition", "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/BatchDeleteRegularAssetConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Condition batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Condition" ], "summary": "Accept the Development Status for an existing Regular Asset Condition resource.", "description": "", "operationId": "AcceptRegularAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Condition" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Condition resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Condition" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Condition resource id's.", "description": "", "operationId": "BatchRejectRegularAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/{id}/Active": { "patch": { "tags": [ "Regular Asset Condition" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetCondition->Version | integer | int32 |\r\n| isActive | RegularAssetCondition->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": "ChangeRegularAssetConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetConditionIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Condition" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetCondition->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": "ChangeRegularAssetConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetConditionPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Condition" ], "summary": "Reject the Development Status for an existing Regular Asset Condition resource.", "description": "", "operationId": "RejectRegularAssetConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Conditions/Batch/Active": { "patch": { "tags": [ "Regular Asset Condition" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetCondition->Id | integer | int64 |\r\n| version | RegularAssetCondition->Version | integer | int32 |\r\n| isActive | RegularAssetCondition->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": "BatchChangeRegularAssetConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetConditionIsActiveResourceActionRequest" } }, { "$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/RegularAssets/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Condition" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetCondition->Id | integer | int64 |\r\n| version | RegularAssetCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetCondition->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": "BatchChangeRegularAssetConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetConditionPermissionTreeResourceActionRequest" } }, { "$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/RegularAssets/Consumption/{id}": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Get a Regular Asset Consumption 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| regularAssetId | RegularAssetConsumption->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetConsumption->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetConsumption->RegularAsset_Description | string | |\r\n| isActive | RegularAssetConsumption->IsActive | boolean | |\r\n| createdByUserId | RegularAssetConsumption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetConsumption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetConsumption->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetConsumption->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetConsumption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetConsumption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetConsumption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetConsumption->ModifiedOn | string | date-time |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetConsumption->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetConsumption->PermissionTree_Description | string | |\r\n| id | RegularAssetConsumption->Id | integer | int64 |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | RegularAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | RegularAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetConsumption->CostElement_Description | string | |\r\n| currencyId | RegularAssetConsumption->Currency_Id | integer | int64 |\r\n| currencyCode | RegularAssetConsumption->Currency_Code | string | |\r\n| currencyDescription | RegularAssetConsumption->Currency_Description | string | |\r\n| currencyRateId | RegularAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateUserSuppliedConversionRate | RegularAssetConsumption->CurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| currencyRateAppliedConversionRate | RegularAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | RegularAssetConsumption->CurrencyRateValue | number | decimal |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | RegularAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RegularAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAssetConsumption->GeneralLedger_Description | string | |\r\n| locationId | RegularAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | RegularAssetConsumption->Location_Code | string | |\r\n| locationDescription | RegularAssetConsumption->Location_Description | string | |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetConsumption->Meter_Code | string | |\r\n| meterDescription | RegularAssetConsumption->Meter_Description | string | |\r\n| meterUnitOfMeasurementId | RegularAssetConsumption->Meter_UnitOfMeasurement_Id | integer | int64 |\r\n| meterUnitOfMeasurementCode | RegularAssetConsumption->Meter_UnitOfMeasurement_Code | string | |\r\n| meterUnitOfMeasurementDescription | RegularAssetConsumption->Meter_UnitOfMeasurement_Description | string | |\r\n| meterReadingId | RegularAssetConsumption->MeterReading_Id | integer | int64 |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| notes | RegularAssetConsumption->Notes | string | |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | RegularAssetConsumption->Resource_Description | string | |\r\n| siteId | RegularAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetConsumption->Site_Code | string | |\r\n| siteDescription | RegularAssetConsumption->Site_Description | string | |\r\n| siteCurrencyId | RegularAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | RegularAssetConsumption->SiteCurrency_Code | string | |\r\n| siteCurrencyDescription | RegularAssetConsumption->SiteCurrency_Description | string | |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RegularAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | RegularAssetConsumption->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | RegularAssetConsumption->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | RegularAssetConsumption->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | RegularAssetConsumption->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | RegularAssetConsumption->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | RegularAssetConsumption->StockItem_Warehouse_Description | string | |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetConsumption->Supplier_Description | string | |\r\n| totalCost | RegularAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | RegularAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n", "operationId": "GetRegularAssetConsumption", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Consumption Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Consumption", "schema": { "$ref": "#/definitions/GetRegularAssetConsumptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Consumption" ], "summary": "Update an existing Regular Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | RegularAssetConsumption->Currency_Id | integer | int64 |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | RegularAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | Nullable | False | |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetConsumption", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Consumption was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-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 Consumption" ], "summary": "Delete an existing Regular Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetConsumption->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": "DeleteRegularAssetConsumption", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Consumption 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/RegularAssets/Consumption/{assetConsumptionId}/Costing": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Get a collection of Costing resources for the Regular Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Costing->Id | integer | int64 |\r\n| description | Costing->Description | string | |\r\n| quantity | Costing->Quantity | number | decimal |\r\n| costElementId | Costing->CostElement_Id | integer | int64 |\r\n| costElementCode | Costing->CostElement_Code | string | |\r\n| costElementDescription | Costing->CostElement_Description | string | |\r\n| costCentreId | Costing->CostCentre_Id | integer | int64 |\r\n| costCentreCode | Costing->CostCentre_Code | string | |\r\n| costCentreDescription | Costing->CostCentre_Description | string | |\r\n| generalLedgerId | Costing->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | Costing->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | Costing->GeneralLedger_Description | string | |\r\n| totalCostInSiteCurrency | Costing->TotalCostInSiteCurrency | number | decimal |\r\n| totalCostInBaseCurrency | Costing->TotalCostInBaseCurrency | number | decimal |\r\n| siteId | Costing->Site_Id | integer | int64 |\r\n| siteCode | Costing->Site_Code | string | |\r\n| siteDescription | Costing->Site_Description | string | |\r\n", "operationId": "GetCostingForRegularAssetConsumptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "assetConsumptionId", "in": "path", "required": true, "description": "Asset Consumption 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 Consumption collection", "schema": { "$ref": "#/definitions/GetCostingCollectionForRegularAssetConsumptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Get a collection of Regular Asset Consumption 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 | RegularAssetConsumption->Id | integer | int64 |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| regularAssetId | RegularAssetConsumption->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetConsumption->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetConsumption->RegularAsset_Description | string | |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | RegularAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | RegularAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | RegularAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RegularAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAssetConsumption->GeneralLedger_Description | string | |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetConsumption->CostElement_Description | string | |\r\n| locationId | RegularAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | RegularAssetConsumption->Location_Code | string | |\r\n| locationDescription | RegularAssetConsumption->Location_Description | string | |\r\n| siteId | RegularAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetConsumption->Site_Code | string | |\r\n| siteDescription | RegularAssetConsumption->Site_Description | string | |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RegularAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetConsumption->Meter_Code | string | |\r\n| meterDescription | RegularAssetConsumption->Meter_Description | string | |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetConsumption->Supplier_Description | string | |\r\n| siteCurrencyId | RegularAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | RegularAssetConsumption->SiteCurrency_Code | string | |\r\n| currencyRateId | RegularAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | RegularAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n| totalCost | RegularAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | RegularAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | RegularAssetConsumption->Resource_Description | string | |\r\n", "operationId": "GetRegularAssetConsumptionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Consumption collection", "schema": { "$ref": "#/definitions/GetRegularAssetConsumptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Consumption" ], "summary": "Create a new Regular Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetId | RegularAssetConsumption->RegularAsset_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | RegularAssetConsumption->Currency_Id | integer | int64 |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | RegularAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| consumableId | Required | True | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | System Generated | true | If no value specified |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| unitPrice | System Generated | true | If no value specified |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetConsumption", "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/CreateRegularAssetConsumptionResourceActionRequest" } }, { "$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/RegularAssets/{id}/Consumption": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Get a collection of RegularAssetConsumption resources for the RegularAsset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetConsumption->Id | integer | int64 |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| regularAssetId | RegularAssetConsumption->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetConsumption->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetConsumption->RegularAsset_Description | string | |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | RegularAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | RegularAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearId | RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| financialYearPeriodCode | RegularAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RegularAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAssetConsumption->GeneralLedger_Description | string | |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetConsumption->CostElement_Description | string | |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RegularAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| locationId | RegularAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | RegularAssetConsumption->Location_Code | string | |\r\n| locationDescription | RegularAssetConsumption->Location_Description | string | |\r\n| siteId | RegularAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetConsumption->Site_Code | string | |\r\n| siteDescription | RegularAssetConsumption->Site_Description | string | |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetConsumption->Meter_Code | string | |\r\n| meterDescription | RegularAssetConsumption->Meter_Description | string | |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetConsumption->Supplier_Description | string | |\r\n| siteCurrencyId | RegularAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | RegularAssetConsumption->SiteCurrency_Code | string | |\r\n| currencyRateId | RegularAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateAppliedConversionRate | RegularAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n| totalCost | RegularAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | RegularAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | RegularAssetConsumption->Resource_Description | string | |\r\n", "operationId": "GetRegularAssetConsumptionForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Consumption collection", "schema": { "$ref": "#/definitions/GetRegularAssetConsumptionForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionChangePermissionTree": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup the permission set for changing the Regular Asset Consumption.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetConsumptionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConsumptionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionConsumable": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup the Consumable for the Regular Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Consumable->Id | integer | int64 |\r\n| code | Consumable->Code | string | |\r\n| description | Consumable->Description | string | |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Consumable->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Consumable->UnitOfMeasurement_Description | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| currencyCode | Consumable->Currency_Code | string | |\r\n| currencyDescription | Consumable->Currency_Description | string | |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\r\n", "operationId": "LookupRegularAssetConsumptionConsumable", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Consumable collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionConsumableLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionCostCentre": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Cost Centre for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | CostCentre->Id | integer | int64 |\r\n| code | CostCentre->Code | string | |\r\n| description | CostCentre->Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionCostCentre", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Cost Centre collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionCostCentreLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionCostElement": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Cost Element for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetConsumptionCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConsumptionCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionCurrency": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Currency for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionFinancialYearPeriod": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Financial Year Period for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionFinancialYearPeriod", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Financial Year Period collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionGeneralLedger": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup General Ledger for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | GeneralLedger->Id | integer | int64 |\r\n| code | GeneralLedger->Code | string | |\r\n| description | GeneralLedger->Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionGeneralLedger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable General Ledger collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionGeneralLedgerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup the permission set for creating the Regular Asset Consumption.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetConsumptionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConsumptionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionMeter": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Meter for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Meter->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Meter->UnitOfMeasurement_Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionRegularAsset": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup the Regular Asset for the Regular Asset Consumption.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| siteId | RegularAsset->Site_Id | integer | int64 |\r\n| siteFinancialYearPeriodId | RegularAsset->Site_FinancialYearPeriod_Id | integer | int64 |\r\n| siteFinancialYearPeriodCode | RegularAsset->Site_FinancialYearPeriod_Code | string | |\r\n| siteFinancialYearPeriodDescription | RegularAsset->Site_FinancialYearPeriod_Description | string | |\r\n| siteCurrencyId | RegularAsset->Site_Currency_Id | integer | int64 |\r\n| siteCurrencyCode | RegularAsset->Site_Currency_Code | string | |\r\n| siteCurrencyDescription | RegularAsset->Site_Currency_Description | string | |\r\n| siteCode | RegularAsset->Site_Code | string | |\r\n| siteDescription | RegularAsset->Site_Description | string | |\r\n| costCentreId | RegularAsset->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAsset->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAsset->CostCentre_Description | string | |\r\n| generalLedgerId | RegularAsset->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAsset->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAsset->GeneralLedger_Description | string | |\r\n| locationId | RegularAsset->Location_Id | integer | int64 |\r\n| locationCode | RegularAsset->Location_Code | string | |\r\n| locationDescription | RegularAsset->Location_Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionResource": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Resource for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\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| costElementCode | Resource->CostElement_Code | string | |\r\n| costElementDescription | Resource->CostElement_Description | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupRegularAssetConsumptionResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConsumptionResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionStockItem": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Stock Item for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionStockItem", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Stock Item collection", "schema": { "$ref": "#/definitions/RegularAssetConsumptionStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionSupplier": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Supplier for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n| siteCurrencyId | Supplier->Site_Currency_Id | integer | int64 |\r\n| siteCurrencyCode | Supplier->Site_Currency_Code | string | |\r\n| siteCurrencyDescription | Supplier->Site_Currency_Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConsumptionSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Lookups/LookupRegularAssetConsumptionUnitOfMeasurement": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Lookup Unit Of Measurement for the Regular Asset Consumption", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupRegularAssetConsumptionUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetConsumptionUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Batch/{ids}": { "get": { "tags": [ "Regular Asset Consumption" ], "summary": "Get a collection of Regular Asset Consumption 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| regularAssetId | RegularAssetConsumption->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetConsumption->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetConsumption->RegularAsset_Description | string | |\r\n| isActive | RegularAssetConsumption->IsActive | boolean | |\r\n| createdByUserId | RegularAssetConsumption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetConsumption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetConsumption->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetConsumption->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetConsumption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetConsumption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetConsumption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetConsumption->ModifiedOn | string | date-time |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetConsumption->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetConsumption->PermissionTree_Description | string | |\r\n| id | RegularAssetConsumption->Id | integer | int64 |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumableCode | RegularAssetConsumption->Consumable_Code | string | |\r\n| consumableDescription | RegularAssetConsumption->Consumable_Description | string | |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costCentreCode | RegularAssetConsumption->CostCentre_Code | string | |\r\n| costCentreDescription | RegularAssetConsumption->CostCentre_Description | string | |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetConsumption->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetConsumption->CostElement_Description | string | |\r\n| currencyId | RegularAssetConsumption->Currency_Id | integer | int64 |\r\n| currencyCode | RegularAssetConsumption->Currency_Code | string | |\r\n| currencyDescription | RegularAssetConsumption->Currency_Description | string | |\r\n| currencyRateId | RegularAssetConsumption->CurrencyRate_Id | integer | int64 |\r\n| currencyRateUserSuppliedConversionRate | RegularAssetConsumption->CurrencyRate_UserSuppliedConversionRate | number | decimal |\r\n| currencyRateAppliedConversionRate | RegularAssetConsumption->CurrencyRate_AppliedConversionRate | number | decimal |\r\n| currencyRateValue | RegularAssetConsumption->CurrencyRateValue | number | decimal |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | RegularAssetConsumption->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | RegularAssetConsumption->FinancialYearPeriod_Description | string | |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| generalLedgerCode | RegularAssetConsumption->GeneralLedger_Code | string | |\r\n| generalLedgerDescription | RegularAssetConsumption->GeneralLedger_Description | string | |\r\n| locationId | RegularAssetConsumption->Location_Id | integer | int64 |\r\n| locationCode | RegularAssetConsumption->Location_Code | string | |\r\n| locationDescription | RegularAssetConsumption->Location_Description | string | |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetConsumption->Meter_Code | string | |\r\n| meterDescription | RegularAssetConsumption->Meter_Description | string | |\r\n| meterUnitOfMeasurementId | RegularAssetConsumption->Meter_UnitOfMeasurement_Id | integer | int64 |\r\n| meterUnitOfMeasurementCode | RegularAssetConsumption->Meter_UnitOfMeasurement_Code | string | |\r\n| meterUnitOfMeasurementDescription | RegularAssetConsumption->Meter_UnitOfMeasurement_Description | string | |\r\n| meterReadingId | RegularAssetConsumption->MeterReading_Id | integer | int64 |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| notes | RegularAssetConsumption->Notes | string | |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetConsumption->Resource_Code | string | |\r\n| resourceDescription | RegularAssetConsumption->Resource_Description | string | |\r\n| siteId | RegularAssetConsumption->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetConsumption->Site_Code | string | |\r\n| siteDescription | RegularAssetConsumption->Site_Description | string | |\r\n| siteCurrencyId | RegularAssetConsumption->SiteCurrency_Id | integer | int64 |\r\n| siteCurrencyCode | RegularAssetConsumption->SiteCurrency_Code | string | |\r\n| siteCurrencyDescription | RegularAssetConsumption->SiteCurrency_Description | string | |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RegularAssetConsumption->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | RegularAssetConsumption->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | RegularAssetConsumption->StockItem_MaterialMaster_Code | string | |\r\n| stockItemMaterialMasterDescription | RegularAssetConsumption->StockItem_MaterialMaster_Description | string | |\r\n| stockItemWarehouseId | RegularAssetConsumption->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | RegularAssetConsumption->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | RegularAssetConsumption->StockItem_Warehouse_Description | string | |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| supplierCode | RegularAssetConsumption->Supplier_Code | string | |\r\n| supplierDescription | RegularAssetConsumption->Supplier_Description | string | |\r\n| totalCost | RegularAssetConsumption->TotalCost | number | decimal |\r\n| totalCostInSiteCurrency | RegularAssetConsumption->TotalCostInSiteCurrency | number | decimal |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetConsumption->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetConsumption->UnitOfMeasurement_Description | string | |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n", "operationId": "BatchGetRegularAssetConsumption", "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 Consumption 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 Consumption collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetConsumptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Batch": { "post": { "tags": [ "Regular Asset Consumption" ], "summary": "Create a new collection of Regular Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetId | RegularAssetConsumption->RegularAsset_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetConsumption->PermissionTree_Id | integer | int64 |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | RegularAssetConsumption->Currency_Id | integer | int64 |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | RegularAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| consumableId | Required | True | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | System Generated | true | If no value specified |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| unitPrice | System Generated | true | If no value specified |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| costCentreId | System Generated | true | If no value specified |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | System Generated | true | If no value specified |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | System Generated | true | If no value specified |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | System Generated | true | If no value specified |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetConsumption", "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/BatchCreateRegularAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset Consumption 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 Consumption" ], "summary": "Update a collection of existing Regular Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetConsumption->Id | integer | int64 |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| resourceId | RegularAssetConsumption->Resource_Id | integer | int64 |\r\n| consumableId | RegularAssetConsumption->Consumable_Id | integer | int64 |\r\n| consumedOn | RegularAssetConsumption->ConsumedOn | string | date-time |\r\n| stockItemId | RegularAssetConsumption->StockItem_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetConsumption->UnitOfMeasurement_Id | integer | int64 |\r\n| quantity | RegularAssetConsumption->Quantity | number | decimal |\r\n| meterId | RegularAssetConsumption->Meter_Id | integer | int64 |\r\n| meterReadingValue | RegularAssetConsumption->MeterReadingValue | number | decimal |\r\n| meterReadingOn | RegularAssetConsumption->MeterReadingOn | string | date-time |\r\n| supplierId | RegularAssetConsumption->Supplier_Id | integer | int64 |\r\n| currencyId | RegularAssetConsumption->Currency_Id | integer | int64 |\r\n| unitPrice | RegularAssetConsumption->UnitPrice | number | decimal |\r\n| costCentreId | RegularAssetConsumption->CostCentre_Id | integer | int64 |\r\n| costElementId | RegularAssetConsumption->CostElement_Id | integer | int64 |\r\n| generalLedgerId | RegularAssetConsumption->GeneralLedger_Id | integer | int64 |\r\n| financialYearPeriodId | RegularAssetConsumption->FinancialYearPeriod_Id | integer | int64 |\r\n| notes | RegularAssetConsumption->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| consumableId | Nullable | False | |\r\n| consumedOn | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | >= 0| |\r\n| meterId | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Nullable | False | RegularAssetConsumption->MeterReadingOn ne NULL |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingValue | Min Value | >= 0| |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| meterReadingOn | Nullable | False | RegularAssetConsumption->MeterReadingValue ne NULL |\r\n| currencyId | Nullable | False | |\r\n| unitPrice | Nullable | False | |\r\n| unitPrice | Min Value | > 0| |\r\n| costCentreId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| generalLedgerId | Nullable | False | |\r\n| financialYearPeriodId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetConsumption", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Consumption 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 Consumption" ], "summary": "Delete a collection of existing Regular Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetConsumption->Id | integer | int64 |\r\n| version | RegularAssetConsumption->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": "BatchDeleteRegularAssetConsumption", "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/BatchDeleteRegularAssetConsumptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Consumption 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/RegularAssets/Consumption/{id}/Active": { "patch": { "tags": [ "Regular Asset Consumption" ], "summary": "Change the IsActive status for an existing Regular Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| isActive | RegularAssetConsumption->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": "ChangeRegularAssetConsumptionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetConsumptionIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Consumption" ], "summary": "Change the PermissionTree for an existing Regular Asset Consumption resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetConsumption->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": "ChangeRegularAssetConsumptionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Consumption Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetConsumptionPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/ValidateMeterAdr": { "post": { "tags": [ "Regular Asset Consumption" ], "summary": "Validate whether the Meter Reading will cause the Meter's AverageDailyRate to exceed the allowed configured values.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| meterId | ValidateMeterAdrEntity->Meter_Id | integer | int64 |\r\n| meterReadingId | ValidateMeterAdrEntity->MeterReading_Id | integer | int64 |\r\n| readingValue | ValidateMeterAdrEntity->ReadingValue | number | decimal |\r\n| readingOn | ValidateMeterAdrEntity->ReadingOn | string | date-time |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n\r\n", "operationId": "ValidateRegularAssetConsumptionMeterAdr", "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/ValidateAssetConsumptionMeterAdrResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Consumption/Batch/Active": { "patch": { "tags": [ "Regular Asset Consumption" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Consumption resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetConsumption->Id | integer | int64 |\r\n| version | RegularAssetConsumption->Version | integer | int32 |\r\n| isActive | RegularAssetConsumption->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": "BatchChangeRegularAssetConsumptionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetConsumptionIsActiveResourceActionRequest" } }, { "$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/RegularAssets/Documents/{id}": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Get a collection of Regular Asset Document resources for the Regular Asset.", "description": "### Response Body\r\n#### 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 | RegularAssetDocument->InheritedFrom_Id | integer | int64 |\r\n| regularAssetId | RegularAssetDocument->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetDocument->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetDocument->RegularAsset_Description | string | |\r\n| developmentStatus | RegularAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | RegularAssetDocument->IsHistorical | boolean | |\r\n| isInherited | RegularAssetDocument->IsInherited | boolean | |\r\n| isProposed | RegularAssetDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetDocument->Unsynchronised | boolean | |\r\n| isActive | RegularAssetDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Document", "schema": { "$ref": "#/definitions/GetRegularAssetDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Document" ], "summary": "Update an existing Regular Asset 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 | RegularAssetDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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 Document" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetDocument->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": "DeleteRegularAssetDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssets/{id}/Documents": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Get a collection of Regular Asset Document resources for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetDocument->Id | integer | int64 |\r\n| version | RegularAssetDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetDocument->IsInherited | boolean | |\r\n| documentRecordId | RegularAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n| inheritedFromId | RegularAssetDocument->InheritedFrom_Id | integer | int64 |\r\n| createdOn | RegularAssetDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetDocumentCollectionForRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetDocumentCollectionForRegularAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetDocument->Id | integer | int64 |\r\n| version | RegularAssetDocument->Version | integer | int32 |\r\n| regularAssetCode | RegularAssetDocument->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetDocument->RegularAsset_Description | string | |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetDocument->IsInherited | boolean | |\r\n| documentRecordId | RegularAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n| createdOn | RegularAssetDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Document" ], "summary": "Create a new Regular Asset 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| regularAssetId | RegularAssetDocument->RegularAsset_Id | integer | int64 |\r\n| documentRecordId | RegularAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | 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": "CreateRegularAssetDocument", "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/CreateRegularAssetDocumentResourceActionRequest" } }, { "$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/RegularAssets/Documents/Lookups/LookupRegularAssetDocumentChangePermissionTree": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Lookups/LookupRegularAssetDocument": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Lookup the for the Regular Asset 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": "LookupRegularAssetDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Lookups/LookupRegularAssetDocumentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Lookups/LookupRegularAssetDocumentRegularAsset": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Lookup the Regular Asset Document for the Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetDocumentRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetDocumentRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Document" ], "summary": "Get a collection of Regular Asset 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| inheritedFromId | RegularAssetDocument->InheritedFrom_Id | integer | int64 |\r\n| regularAssetId | RegularAssetDocument->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetDocument->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetDocument->RegularAsset_Description | string | |\r\n| developmentStatus | RegularAssetDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | RegularAssetDocument->IsHistorical | boolean | |\r\n| isInherited | RegularAssetDocument->IsInherited | boolean | |\r\n| isProposed | RegularAssetDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetDocument->Unsynchronised | boolean | |\r\n| isActive | RegularAssetDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetDocument", "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 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 Document collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Batch": { "post": { "tags": [ "Regular Asset Document" ], "summary": "Create a new collection of Regular Asset 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| regularAssetId | RegularAssetDocument->RegularAsset_Id | integer | int64 |\r\n| documentRecordId | RegularAssetDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | 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": "BatchCreateRegularAssetDocument", "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/BatchCreateRegularAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Document" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetDocument->Id | integer | int64 |\r\n| version | RegularAssetDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdateRegularAssetDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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 Document" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetDocument->Id | integer | int64 |\r\n| version | RegularAssetDocument->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": "BatchDeleteRegularAssetDocument", "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/BatchDeleteRegularAssetDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssets/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Document" ], "summary": "Accept the Development Status for an existing Regular Asset Document resource.", "description": "", "operationId": "AcceptRegularAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Document" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Document resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Document" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Document resource id's.", "description": "", "operationId": "BatchRejectRegularAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/{id}/Active": { "patch": { "tags": [ "Regular Asset Document" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetDocument->Version | integer | int32 |\r\n| isActive | RegularAssetDocument->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": "ChangeRegularAssetDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetDocumentIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Document" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetDocument->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": "ChangeRegularAssetDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetDocumentPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Document" ], "summary": "Reject the Development Status for an existing Regular Asset Document resource.", "description": "", "operationId": "RejectRegularAssetDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Documents/Batch/Active": { "patch": { "tags": [ "Regular Asset Document" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetDocument->Id | integer | int64 |\r\n| version | RegularAssetDocument->Version | integer | int32 |\r\n| isActive | RegularAssetDocument->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": "BatchChangeRegularAssetDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetDocumentIsActiveResourceActionRequest" } }, { "$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/RegularAssets/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Document" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetDocument->Id | integer | int64 |\r\n| version | RegularAssetDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetDocument->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": "BatchChangeRegularAssetDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetDocumentPermissionTreeResourceActionRequest" } }, { "$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/RegularAssets/FileAttachments/{id}/Download": { "get": { "tags": [ "Regular Asset File Attachment" ], "summary": "Download the content for a Regular Asset File Attachment resource.", "description": "", "operationId": "GetRegularAssetFileAttachmentContent", "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/RegularAssets/FileAttachments/{id}": { "get": { "tags": [ "Regular Asset File Attachment" ], "summary": "Get a Regular Asset 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| regularAssetId | RegularAssetFileAttachment->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetFileAttachment->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetFileAttachment->RegularAsset_Description | string | |\r\n| createdByUserId | RegularAssetFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RegularAssetFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RegularAssetFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RegularAssetFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RegularAssetFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RegularAssetFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RegularAssetFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RegularAssetFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RegularAssetFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RegularAssetFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RegularAssetFileAttachment->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 | RegularAssetFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RegularAssetFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RegularAssetFileAttachment->FileFullName | string | |\r\n| fileName | RegularAssetFileAttachment->FileName | string | |\r\n| fileTypeId | RegularAssetFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RegularAssetFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetFileAttachment->IsRestricted | boolean | |\r\n| id | RegularAssetFileAttachment->Id | integer | int64 |\r\n| isActive | RegularAssetFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetFileAttachment->PermissionTree_Description | string | |\r\n| version | RegularAssetFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetRegularAssetFileAttachment", "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 File Attachment", "schema": { "$ref": "#/definitions/GetRegularAssetFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset File Attachment" ], "summary": "Update an existing Regular Asset 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 | RegularAssetFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | RegularAssetFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | RegularAssetFileAttachment->FileName | string | |\r\n| isRestricted | RegularAssetFileAttachment->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": "UpdateRegularAssetFileAttachment", "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/UpdateRegularAssetFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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 File Attachment" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetFileAttachment->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": "DeleteRegularAssetFileAttachment", "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/DeleteRegularAssetFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssets/{id}/FileAttachments": { "get": { "tags": [ "Regular Asset File Attachment" ], "summary": "Get a collection of Regular Asset File Attachment resources for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetFileAttachment->Version | integer | int32 |\r\n| fileFullName | RegularAssetFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RegularAssetFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | RegularAssetFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RegularAssetFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RegularAssetFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RegularAssetFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetFileAttachmentCollectionForRegularAsset", "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 File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetFileAttachmentCollectionForRegularAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/FileAttachments": { "get": { "tags": [ "Regular Asset File Attachment" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetFileAttachment->Version | integer | int32 |\r\n| regularAssetId | RegularAssetFileAttachment->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetFileAttachment->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetFileAttachment->RegularAsset_Description | string | |\r\n| fileFullName | RegularAssetFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RegularAssetFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | RegularAssetFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RegularAssetFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RegularAssetFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RegularAssetFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetFileAttachmentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/FileAttachments/Upload": { "post": { "tags": [ "Regular Asset File Attachment" ], "summary": "Upload and create a new Regular Asset 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| regularAssetId | RegularAssetFileAttachment->RegularAsset_Id | integer | int64 |\r\n| isRestricted | RegularAssetFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RegularAssetFileAttachment->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| regularAssetId | Required | True | |\r\n| regularAssetId | 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": "CreateRegularAssetFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRegularAssetFileAttachmentResourceActionRequest" } } ], "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/RegularAssets/FileAttachments/{id}/Upload": { "put": { "tags": [ "Regular Asset File Attachment" ], "summary": "Upload new content for an existing Regular Asset 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 | RegularAssetFileAttachment->Version | integer | int32 |\r\n| bytes | RegularAssetFileAttachment->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": "UpdateRegularAssetFileAttachmentContent", "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/UpdateRegularAssetFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Regular Asset File Attachment" ], "summary": "Get a collection of Regular Asset 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| regularAssetId | RegularAssetFileAttachment->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetFileAttachment->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetFileAttachment->RegularAsset_Description | string | |\r\n| createdByUserId | RegularAssetFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RegularAssetFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RegularAssetFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RegularAssetFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RegularAssetFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RegularAssetFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RegularAssetFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RegularAssetFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RegularAssetFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RegularAssetFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RegularAssetFileAttachment->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 | RegularAssetFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RegularAssetFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RegularAssetFileAttachment->FileFullName | string | |\r\n| fileName | RegularAssetFileAttachment->FileName | string | |\r\n| fileTypeId | RegularAssetFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RegularAssetFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetFileAttachment->IsRestricted | boolean | |\r\n| id | RegularAssetFileAttachment->Id | integer | int64 |\r\n| isActive | RegularAssetFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetFileAttachment->PermissionTree_Description | string | |\r\n| version | RegularAssetFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetFileAttachment", "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 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 File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Regular Asset File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Regular Asset 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": "GetRegularAssetFileAttachmentContentHistory", "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 File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/FileAttachments/Upload/Batch": { "post": { "tags": [ "Regular Asset File Attachment" ], "summary": "Upload and create a new collection of Regular Asset 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| regularAssetId | RegularAssetFileAttachment->RegularAsset_Id | integer | int64 |\r\n| isRestricted | RegularAssetFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RegularAssetFileAttachment->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| regularAssetId | Required | True | |\r\n| regularAssetId | 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": "BatchCreateRegularAssetFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRegularAssetFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/FileAttachments/Batch": { "patch": { "tags": [ "Regular Asset File Attachment" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetFileAttachment->Version | integer | int32 |\r\n| isRestricted | RegularAssetFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetFileAttachment->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": "BatchUpdateRegularAssetFileAttachment", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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 File Attachment" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetFileAttachment->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": "BatchDeleteRegularAssetFileAttachment", "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/BatchDeleteRegularAssetFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssets/Meters/{id}": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Get a Regular Asset Meter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RegularAssetMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetMeter->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetMeter->CreatedOn | string | date-time |\r\n| isActive | RegularAssetMeter->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetMeter->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetMeter->PermissionTree_Description | string | |\r\n| version | RegularAssetMeter->Version | integer | int32 |\r\n| id | RegularAssetMeter->Id | integer | int64 |\r\n| regularAssetId | RegularAssetMeter->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMeter->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMeter->RegularAsset_Description | string | |\r\n| isMainMeter | RegularAssetMeter->IsMainMeter | boolean | |\r\n| meterId | RegularAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetMeter->Meter_Code | string | |\r\n| meterDescription | RegularAssetMeter->Meter_Description | string | |\r\n| assetMeterType | RegularAssetMeter->AssetMeterType | string (Allowed values: [RegularAssetMeter]) | enum |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n| sequenceNumber | RegularAssetMeter->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetMeter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Meter", "schema": { "$ref": "#/definitions/GetRegularAssetMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Meter" ], "summary": "Update an existing Regular Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetMeter->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMeter->SequenceNumber | integer | int32 |\r\n| isMainMeter | RegularAssetMeter->IsMainMeter | boolean | |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetMeter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Meter was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Meter" ], "summary": "Delete an existing Regular Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetMeter->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": "DeleteRegularAssetMeter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Meter was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Get a collection of Regular Asset Meter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetMeter->Version | integer | int32 |\r\n| id | RegularAssetMeter->Id | integer | int64 |\r\n| regularAssetId | RegularAssetMeter->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMeter->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMeter->RegularAsset_Description | string | |\r\n| meterId | RegularAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetMeter->Meter_Code | string | |\r\n| meterDescription | RegularAssetMeter->Meter_Description | string | |\r\n| isActive | RegularAssetMeter->IsActive | boolean | |\r\n| isMainMeter | RegularAssetMeter->IsMainMeter | boolean | |\r\n| sequenceNumber | RegularAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n", "operationId": "GetRegularAssetMeterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/GetRegularAssetMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Meter" ], "summary": "Create a new Regular Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetMeter->PermissionTree_Id | integer | int64 |\r\n| regularAssetId | RegularAssetMeter->RegularAsset_Id | integer | int64 |\r\n| meterId | RegularAssetMeter->Meter_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | >= 0| |\r\n| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetMeter", "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/CreateRegularAssetMeterResourceActionRequest" } }, { "$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/RegularAssets/{id}/Meters": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Get a collection of Regular Asset Meter resources for the Asset.", "description": "### Response Body\r\n#### 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 | RegularAssetMeter->Version | integer | int32 |\r\n| id | RegularAssetMeter->Id | integer | int64 |\r\n| meterId | RegularAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetMeter->Meter_Code | string | |\r\n| meterDescription | RegularAssetMeter->Meter_Description | string | |\r\n| isActive | RegularAssetMeter->IsActive | boolean | |\r\n| isMainMeter | RegularAssetMeter->IsMainMeter | boolean | |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n", "operationId": "GetRegularAssetMeterForRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Meter collection", "schema": { "$ref": "#/definitions/GetRegularAssetMeterForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/Lookups/LookupRegularAssetMeterAsset": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Lookup the Regular Asset for the Regular Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| siteId | RegularAsset->Site_Id | integer | int64 |\r\n| siteCode | RegularAsset->Site_Code | string | |\r\n| siteDescription | RegularAsset->Site_Description | string | |\r\n", "operationId": "LookupRegularAssetMeterAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetMeterAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/Lookups/LookupRegularAssetMeterChangePermissionTree": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Lookup the permission set for changing the Regular Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetMeterChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetMeterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/Lookups/LookupRegularAssetMeterInsertPermissionTree": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Lookup the permission set for creating the Regular Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetMeterInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetMeterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/Lookups/LookupRegularAssetMeterMeter": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Lookup the Meter for the Regular Asset Meter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| siteCode | Meter->Site_Code | string | |\r\n| siteDescription | Meter->Site_Description | string | |\r\n", "operationId": "LookupRegularAssetMeterMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter collection", "schema": { "$ref": "#/definitions/RegularAssetMeterMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/Batch/{ids}": { "get": { "tags": [ "Regular Asset Meter" ], "summary": "Get a collection of Regular Asset Meter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RegularAssetMeter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetMeter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetMeter->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetMeter->CreatedOn | string | date-time |\r\n| isActive | RegularAssetMeter->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetMeter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetMeter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetMeter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetMeter->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetMeter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetMeter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetMeter->PermissionTree_Description | string | |\r\n| version | RegularAssetMeter->Version | integer | int32 |\r\n| id | RegularAssetMeter->Id | integer | int64 |\r\n| regularAssetId | RegularAssetMeter->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMeter->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMeter->RegularAsset_Description | string | |\r\n| isMainMeter | RegularAssetMeter->IsMainMeter | boolean | |\r\n| meterId | RegularAssetMeter->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetMeter->Meter_Code | string | |\r\n| meterDescription | RegularAssetMeter->Meter_Description | string | |\r\n| assetMeterType | RegularAssetMeter->AssetMeterType | string (Allowed values: [RegularAssetMeter]) | enum |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n| sequenceNumber | RegularAssetMeter->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetMeter", "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 Meter id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Meter collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetMeterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/Batch": { "post": { "tags": [ "Regular Asset Meter" ], "summary": "Create a new collection of Regular Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetMeter->PermissionTree_Id | integer | int64 |\r\n| regularAssetId | RegularAssetMeter->RegularAsset_Id | integer | int64 |\r\n| meterId | RegularAssetMeter->Meter_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMeter->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | >= 0| |\r\n| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetMeter", "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/BatchCreateRegularAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset Meter batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Meter" ], "summary": "Update a collection of existing Regular Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetMeter->Id | integer | int64 |\r\n| version | RegularAssetMeter->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMeter->SequenceNumber | integer | int32 |\r\n| isMainMeter | RegularAssetMeter->IsMainMeter | boolean | |\r\n| notes | RegularAssetMeter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetMeter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Meter batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Meter" ], "summary": "Delete a collection of existing Regular Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetMeter->Id | integer | int64 |\r\n| version | RegularAssetMeter->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": "BatchDeleteRegularAssetMeter", "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/BatchDeleteRegularAssetMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Meter batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/{id}/Active": { "patch": { "tags": [ "Regular Asset Meter" ], "summary": "Change the IsActive status for an existing Regular Asset Meter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetMeter->Version | integer | int32 |\r\n| isActive | RegularAssetMeter->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": "ChangeRegularAssetMeterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetMeterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/{id}/SetMainMeterStatus": { "patch": { "tags": [ "Regular Asset Meter" ], "summary": "Set the Main Meter status.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | SetRegularAssetMainMeterStatus->Version | integer | int32 |\r\n| isMainMeter | SetRegularAssetMainMeterStatus->IsMainMeter | 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| isMainMeter | Required | True | |\r\n| isMainMeter | Nullable | False | |\r\n\r\n", "operationId": "SetRegularAssetMainMeterStatus", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/SetMainMeterStatusResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Meters/Batch/Active": { "patch": { "tags": [ "Regular Asset Meter" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Meter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetMeter->Id | integer | int64 |\r\n| version | RegularAssetMeter->Version | integer | int32 |\r\n| isActive | RegularAssetMeter->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": "BatchChangeRegularAssetMeterIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetMeterIsActiveResourceActionRequest" } }, { "$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/RegularAssets/MonitoringPointTriggers/{id}": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| isActive | RegularAssetMonitoringPointTrigger->IsActive | boolean | |\r\n| isHistorical | RegularAssetMonitoringPointTrigger->IsHistorical | boolean | |\r\n| isInherited | RegularAssetMonitoringPointTrigger->IsInherited | boolean | |\r\n| isProposed | RegularAssetMonitoringPointTrigger->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetMonitoringPointTrigger->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetMonitoringPointTrigger->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetMonitoringPointTrigger->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetMonitoringPointTrigger->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetMonitoringPointTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetMonitoringPointTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetMonitoringPointTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetMonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetMonitoringPointTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetMonitoringPointTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetMonitoringPointTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetMonitoringPointTrigger->ModifiedOn | string | date-time |\r\n| version | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetMonitoringPointTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetMonitoringPointTrigger->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetMonitoringPointTrigger->InheritedFrom_Id | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Description | string | |\r\n| notes | RegularAssetMonitoringPointTrigger->Notes | string | |\r\n| recordType | RegularAssetMonitoringPointTrigger->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetMonitoringPointTrigger->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMonitoringPointTrigger->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMonitoringPointTrigger->RegularAsset_Description | string | |\r\n", "operationId": "GetRegularAssetMonitoringPointTrigger", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Monitoring Point Trigger", "schema": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Update an existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetMonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetMonitoringPointTrigger", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetMonitoringPointTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->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": "DeleteRegularAssetMonitoringPointTrigger", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetMonitoringPointTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Monitoring Point Trigger was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| isActive | RegularAssetMonitoringPointTrigger->IsActive | boolean | |\r\n| regularAssetId | RegularAssetMonitoringPointTrigger->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMonitoringPointTrigger->RegularAsset_Code | string | |\r\n| monitoringPointTriggerId | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| permissionTreeCode | RegularAssetMonitoringPointTrigger->PermissionTree_Code | string | |\r\n| inheritedFromId | RegularAssetMonitoringPointTrigger->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetMonitoringPointTrigger->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| sequenceNumber | RegularAssetMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetMonitoringPointTriggerCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Monitoring Point Trigger collection", "schema": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Create a new Regular Asset 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| permissionTreeId | RegularAssetMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| regularAssetId | RegularAssetMonitoringPointTrigger->RegularAsset_Id | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetMonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| monitoringPointTriggerId | Required | True | |\r\n| monitoringPointTriggerId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetMonitoringPointTrigger", "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/CreateRegularAssetMonitoringPointTriggerResourceActionRequest" } }, { "$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/RegularAssets/{id}/MonitoringPointTriggers": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Get a collection of MonitoringPointTrigger resources for the Regular Asset.", "description": "### Response Body\r\n#### 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 | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| id | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Description | string | |\r\n| notes | RegularAssetMonitoringPointTrigger->Notes | string | |\r\n| developmentStatus | RegularAssetMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n", "operationId": "GetRegularAssetMonitoringPointTriggerForRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Monitoring Point Trigger collection", "schema": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerForRegularAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Lookups/LookupRegularAssetMonitoringPointTriggerChangePermissionTree": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetMonitoringPointTriggerChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Lookups/LookupRegularAssetMonitoringPointTriggerInsertPermissionTree": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetMonitoringPointTriggerInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Lookups/LookupRegularAssetMonitoringPointTriggerMonitoringPointTrigger": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Lookup the Resource for the Regular Asset 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": "LookupRegularAssetMonitoringPointTriggerMonitoringPointTrigger", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetMonitoringPointTriggerResourceLookupMonitoringPointTriggerActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Lookups/LookupRegularAssetMonitoringPointTriggerRegularAsset": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Lookup the Regular Asset for the Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetMonitoringPointTriggerRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetMonitoringPointTriggerRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Batch/{ids}": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetMonitoringPointTrigger->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| isActive | RegularAssetMonitoringPointTrigger->IsActive | boolean | |\r\n| isHistorical | RegularAssetMonitoringPointTrigger->IsHistorical | boolean | |\r\n| isInherited | RegularAssetMonitoringPointTrigger->IsInherited | boolean | |\r\n| isProposed | RegularAssetMonitoringPointTrigger->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetMonitoringPointTrigger->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetMonitoringPointTrigger->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetMonitoringPointTrigger->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetMonitoringPointTrigger->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetMonitoringPointTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetMonitoringPointTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetMonitoringPointTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetMonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetMonitoringPointTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetMonitoringPointTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetMonitoringPointTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetMonitoringPointTrigger->ModifiedOn | string | date-time |\r\n| version | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetMonitoringPointTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetMonitoringPointTrigger->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetMonitoringPointTrigger->InheritedFrom_Id | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Description | string | |\r\n| notes | RegularAssetMonitoringPointTrigger->Notes | string | |\r\n| recordType | RegularAssetMonitoringPointTrigger->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetMonitoringPointTrigger->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMonitoringPointTrigger->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMonitoringPointTrigger->RegularAsset_Description | string | |\r\n", "operationId": "BatchGetRegularAssetMonitoringPointTrigger", "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 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 Monitoring Point Trigger collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetMonitoringPointTriggerResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Batch": { "post": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Create a new collection of Regular Asset 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| permissionTreeId | RegularAssetMonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| regularAssetId | RegularAssetMonitoringPointTrigger->RegularAsset_Id | integer | int64 |\r\n| monitoringPointTriggerId | RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetMonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| monitoringPointTriggerId | Required | True | |\r\n| monitoringPointTriggerId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetMonitoringPointTrigger", "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/BatchCreateRegularAssetMonitoringPointTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Monitoring Point Trigger" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetMonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateRegularAssetMonitoringPointTrigger", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetMonitoringPointTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTrigger->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetMonitoringPointTrigger", "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/BatchDeleteRegularAssetMonitoringPointTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Monitoring Point Trigger batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Accept the Development Status for an existing Regular Asset Monitoring Point Trigger resource.", "description": "", "operationId": "AcceptRegularAssetMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Monitoring Point Trigger resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Monitoring Point Trigger id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Monitoring Point Trigger resource id's.", "description": "", "operationId": "BatchRejectRegularAssetMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Monitoring Point Trigger id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/{id}/Active": { "patch": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| isActive | RegularAssetMonitoringPointTrigger->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": "ChangeRegularAssetMonitoringPointTriggerIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetMonitoringPointTriggerIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetMonitoringPointTrigger->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": "ChangeRegularAssetMonitoringPointTriggerPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetMonitoringPointTriggerPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Reject the Development Status for an existing Regular Asset Monitoring Point Trigger resource.", "description": "", "operationId": "RejectRegularAssetMonitoringPointTriggerDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggers/Batch/Active": { "patch": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| isActive | RegularAssetMonitoringPointTrigger->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": "BatchChangeRegularAssetMonitoringPointTriggerIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetMonitoringPointTriggerIsActiveResourceActionRequest" } }, { "$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/RegularAssets/MonitoringPointTriggers/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Monitoring Point Trigger" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetMonitoringPointTrigger->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetMonitoringPointTrigger->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": "BatchChangeRegularAssetMonitoringPointTriggerPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetMonitoringPointTriggerPermissionTreeResourceActionRequest" } }, { "$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/RegularAssets/MonitoringPointTriggerParameters/{id}": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Get a Regular Asset Monitoring Point Trigger Parameter 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 | RegularAssetMonitoringPointTriggerParameter->Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| isInherited | RegularAssetMonitoringPointTriggerParameter->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetMonitoringPointTriggerParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetMonitoringPointTriggerParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetMonitoringPointTriggerParameter->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetMonitoringPointTriggerParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetMonitoringPointTriggerParameter->ModifiedOn | string | date-time |\r\n| version | RegularAssetMonitoringPointTriggerParameter->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterParameterName | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_ParameterName | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Code | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Description | string | |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Description | string | |\r\n| monitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterParameterType | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| monitoringPointTriggerExpressionParameterParameterName | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterName | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Description | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Code | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Description | string | |\r\n| notes | RegularAssetMonitoringPointTriggerParameter->Notes | string | |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| regularAssetId | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Description | string | |\r\n", "operationId": "GetRegularAssetMonitoringPointTriggerParameter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Parameter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Monitoring Point Trigger Parameter", "schema": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerParameterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Update an existing Regular Asset Monitoring Point Trigger Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetMonitoringPointTriggerParameter->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| notes | RegularAssetMonitoringPointTriggerParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetMonitoringPointTriggerParameter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Monitoring Point Trigger Parameter was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-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 Monitoring Point Trigger Parameter" ], "summary": "Delete an existing Regular Asset Monitoring Point Trigger Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetMonitoringPointTriggerParameter->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": "DeleteRegularAssetMonitoringPointTriggerParameter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Monitoring Point Trigger Parameter Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Monitoring Point Trigger Parameter 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/RegularAssets/MonitoringPointTriggerParameters": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Get a collection of Regular Asset Monitoring Point Trigger Parameter 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 | RegularAssetMonitoringPointTriggerParameter->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTriggerParameter->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Description | string | |\r\n| monitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterParameterName | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterName | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Code | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Description | string | |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Description | string | |\r\n| permissionTreeId | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id | integer | int64 |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| isInherited | RegularAssetMonitoringPointTriggerParameter->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_Id | integer | int64 |\r\n", "operationId": "GetRegularAssetMonitoringPointTriggerParameterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Monitoring Point Trigger Parameter collection", "schema": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerParameterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Create a new Regular Asset Monitoring Point Trigger Parameter resource.", "description": "### Request Body\r\n#### 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 | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| notes | RegularAssetMonitoringPointTriggerParameter->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| monitoringPointTriggerExpressionParameterId | Required | True | |\r\n| monitoringPointTriggerExpressionParameterId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetMonitoringPointTriggerParameter", "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/CreateRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, { "$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/RegularAssets/{id}/MonitoringPointTriggerParameters": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Get a collection of Regular Asset Monitoring Point Trigger Parameter resources for the Regular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetMonitoringPointTriggerParameter->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTriggerParameter->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Description | string | |\r\n| monitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterParameterName | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterName | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Code | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Description | string | |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Description | string | |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| isInherited | RegularAssetMonitoringPointTriggerParameter->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id | integer | int64 |\r\n", "operationId": "GetRegularAssetMonitoringPointTriggerParameterForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Monitoring Point Trigger Parameter collection", "schema": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerParameterForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggerParameters/Lookups/LookupRegularAssetMonitoringPointTriggerParameterChangePermissionTree": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Lookup the permission set for changing the Regular Asset Monitoring Point Trigger Parameter.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetMonitoringPointTriggerParameterChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetMonitoringPointTriggerParameterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggerParameters/Lookups/LookupRegularAssetMonitoringPointTriggerParameterInsertPermissionTree": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Lookup the permission set for creating the Regular Asset Monitoring Point Trigger Parameter.", "description": "### Response Body\r\n#### Payload\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": "LookupRegularAssetMonitoringPointTriggerParameterInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetMonitoringPointTriggerParameterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggerParameters/Lookups/LookupRegularAssetMonitoringPointTriggerParameterMonitoringPoint": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Lookup the Monitoring Point for the Regular Asset Monitoring Point Trigger Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPoint->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPoint->MonitoringPointType_Description | string | |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| assetCode | MonitoringPoint->Asset_Code | string | |\r\n| assetDescription | MonitoringPoint->Asset_Description | string | |\r\n", "operationId": "LookupRegularAssetMonitoringPointTriggerParameterMonitoringPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/RegularAssetMonitoringPointTriggerParameterMonitoringPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggerParameters/Lookups/LookupRegularAssetMonitoringPointTriggerParameterMonitoringPointTriggerExpressionParameter": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Lookup the Monitoring Point Trigger Expression Parameter for the Regular Asset Monitoring Point Trigger Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Expression | string | |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerIdRegularAssetMonitoringPointTriggerMonitoringPointTriggerId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_*Id.RegularAssetMonitoringPointTrigger.MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description | string | |\r\n| parameterType | MonitoringPointTriggerExpressionParameter->ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n", "operationId": "LookupRegularAssetMonitoringPointTriggerParameterMonitoringPointTriggerExpressionParameter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Parameter collection", "schema": { "$ref": "#/definitions/RegularAssetMonitoringPointTriggerParameterMonitoringPointTriggerExpressionParameterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggerParameters/Lookups/LookupRegularAssetMonitoringPointTriggerParameterRegularAsset": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Lookup the Regular Asset for the Regular Asset Monitoring Point Trigger Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetMonitoringPointTriggerParameterRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetMonitoringPointTriggerParameterRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggerParameters/Batch/{ids}": { "get": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Get a collection of Regular Asset Monitoring Point Trigger Parameter 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 | RegularAssetMonitoringPointTriggerParameter->Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| isInherited | RegularAssetMonitoringPointTriggerParameter->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetMonitoringPointTriggerParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetMonitoringPointTriggerParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetMonitoringPointTriggerParameter->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetMonitoringPointTriggerParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetMonitoringPointTriggerParameter->ModifiedOn | string | date-time |\r\n| version | RegularAssetMonitoringPointTriggerParameter->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterParameterName | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_ParameterName | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Id | integer | int64 |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Code | string | |\r\n| inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription | RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Description | string | |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Description | string | |\r\n| monitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterParameterType | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| monitoringPointTriggerExpressionParameterParameterName | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterName | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Description | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeCode | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Code | string | |\r\n| monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Description | string | |\r\n| notes | RegularAssetMonitoringPointTriggerParameter->Notes | string | |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| regularAssetId | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Description | string | |\r\n", "operationId": "BatchGetRegularAssetMonitoringPointTriggerParameter", "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 Monitoring Point Trigger Parameter 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 Monitoring Point Trigger Parameter collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetMonitoringPointTriggerParameterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/MonitoringPointTriggerParameters/Batch": { "post": { "tags": [ "Regular Asset Monitoring Point Trigger Parameter" ], "summary": "Create a new collection of Regular Asset Monitoring Point Trigger Parameter resources.", "description": "### Request Body\r\n#### 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 | RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionParameterId | RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id | integer | int64 |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| notes | RegularAssetMonitoringPointTriggerParameter->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| monitoringPointTriggerExpressionParameterId | Required | True | |\r\n| monitoringPointTriggerExpressionParameterId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetMonitoringPointTriggerParameter", "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/BatchCreateRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset Monitoring Point Trigger Parameter 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 Monitoring Point Trigger Parameter" ], "summary": "Update a collection of existing Regular Asset Monitoring Point Trigger Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetMonitoringPointTriggerParameter->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTriggerParameter->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetMonitoringPointTriggerParameter->SequenceNumber | integer | int32 |\r\n| monitoringPointId | RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id | integer | int64 |\r\n| parameterValue | RegularAssetMonitoringPointTriggerParameter->ParameterValue | object | composite |\r\n| notes | RegularAssetMonitoringPointTriggerParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateRegularAssetMonitoringPointTriggerParameter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Monitoring Point Trigger Parameter 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 Monitoring Point Trigger Parameter" ], "summary": "Delete a collection of existing Regular Asset Monitoring Point Trigger Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetMonitoringPointTriggerParameter->Id | integer | int64 |\r\n| version | RegularAssetMonitoringPointTriggerParameter->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": "BatchDeleteRegularAssetMonitoringPointTriggerParameter", "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/BatchDeleteRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Monitoring Point Trigger Parameter 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/RegularAssets/OptionValues/{id}": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Get a Regular Asset Option Value resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| isCustom | RegularAssetOptionValue->IsCustom | boolean | |\r\n| optionId | RegularAssetOptionValue->Option_Id | integer | int64 |\r\n| optionAllowMultipleValues | RegularAssetOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionCode | RegularAssetOptionValue->Option_Code | string | |\r\n| optionDataType | RegularAssetOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionDescription | RegularAssetOptionValue->Option_Description | string | |\r\n| optionLowerBounds | RegularAssetOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetOptionValue->Option_UpperBounds | string | |\r\n| optionOptionCategoryId | RegularAssetOptionValue->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | RegularAssetOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | RegularAssetOptionValue->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | RegularAssetOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| regularAssetTypeOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Option_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| regularAssetTypeOptionOptionAllowMultipleValues | RegularAssetOptionValue->RegularAssetTypeOption_Option_AllowMultipleValues | boolean | |\r\n| regularAssetTypeOptionOptionLowerBounds | RegularAssetOptionValue->RegularAssetTypeOption_Option_LowerBounds | string | |\r\n| regularAssetTypeOptionOptionDataType | RegularAssetOptionValue->RegularAssetTypeOption_Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| regularAssetTypeOptionOptionUpperBounds | RegularAssetOptionValue->RegularAssetTypeOption_Option_UpperBounds | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryId | RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionOptionCategoryCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Code | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Description | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementId | RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Code | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Description | string | |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | RegularAssetOptionValue->IsActive | boolean | |\r\n| createdByUserId | RegularAssetOptionValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetOptionValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetOptionValue->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetOptionValue->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetOptionValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetOptionValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetOptionValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetOptionValue->ModifiedOn | string | date-time |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetOptionValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetOptionValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetOptionValue->PermissionTree_Description | string | |\r\n| notes | RegularAssetOptionValue->Notes | string | |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| regularAssetId | RegularAssetOptionValue->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetOptionValue->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetOptionValue->RegularAsset_Description | string | |\r\n", "operationId": "GetRegularAssetOptionValue", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Option Value Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Option Value", "schema": { "$ref": "#/definitions/GetRegularAssetOptionValueResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Option Value" ], "summary": "Update an existing Regular Asset Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| notes | RegularAssetOptionValue->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetOptionValue", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Option Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Option Value was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Option Value" ], "summary": "Delete an existing Regular Asset Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetOptionValue->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": "DeleteRegularAssetOptionValue", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Option Value Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Option Value was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Get a collection of Regular Asset Option Value resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | RegularAssetOptionValue->IsActive | boolean | |\r\n| notes | RegularAssetOptionValue->Notes | string | |\r\n| regularAssetId | RegularAssetOptionValue->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetOptionValue->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetOptionValue->RegularAsset_Description | string | |\r\n| regularAssetTypeOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| regularAssetTypeOptionOptionDataType | RegularAssetOptionValue->RegularAssetTypeOption_Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| isCustom | RegularAssetOptionValue->IsCustom | boolean | |\r\n| optionId | RegularAssetOptionValue->Option_Id | integer | int64 |\r\n| optionCode | RegularAssetOptionValue->Option_Code | string | |\r\n| optionDescription | RegularAssetOptionValue->Option_Description | string | |\r\n| optionDataType | RegularAssetOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionLowerBounds | RegularAssetOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetOptionValue->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | RegularAssetOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionOptionCategoryCode | RegularAssetOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementCode | RegularAssetOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| createdOn | RegularAssetOptionValue->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetOptionValue->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetOptionValueCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Option Value collection", "schema": { "$ref": "#/definitions/GetRegularAssetOptionValueCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Option Value" ], "summary": "Create a new Regular Asset Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetOptionValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetOptionValue->RegularAsset_Id | integer | int64 |\r\n| regularAssetTypeOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| optionId | RegularAssetOptionValue->Option_Id | integer | int64 |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| notes | RegularAssetOptionValue->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| regularAssetTypeOptionId | Min Value | > 0| |\r\n| optionId | Nullable | False | |\r\n| optionValue | Required | True | |\r\n| optionValue | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetOptionValue", "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/CreateRegularAssetOptionValueResourceActionRequest" } }, { "$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/RegularAssets/{id}/OptionValues": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Get a collection of RegularAssetOptionValue resources for the RegularAsset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | RegularAssetOptionValue->IsActive | boolean | |\r\n| regularAssetId | RegularAssetOptionValue->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetOptionValue->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetOptionValue->RegularAsset_Description | string | |\r\n| regularAssetTypeOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| optionId | RegularAssetOptionValue->Option_Id | integer | int64 |\r\n| optionOptionCategoryCode | RegularAssetOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementCode | RegularAssetOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| optionDataType | RegularAssetOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionLowerBounds | RegularAssetOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetOptionValue->Option_UpperBounds | string | |\r\n| optionAllowMultipleValues | RegularAssetOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionCode | RegularAssetOptionValue->Option_Code | string | |\r\n| optionDescription | RegularAssetOptionValue->Option_Description | string | |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| isCustom | RegularAssetOptionValue->IsCustom | boolean | |\r\n| createdOn | RegularAssetOptionValue->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetOptionValue->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetOptionValueForAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Option Value collection", "schema": { "$ref": "#/definitions/GetRegularAssetOptionValueForAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Lookups/LookupRegularAssetOptionValueChangePermissionTree": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Lookup the permission set for changing the Regular Asset Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetOptionValueChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetOptionValueChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Lookups/LookupRegularAssetOptionValueInsertPermissionTree": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Lookup the permission set for creating the Regular Asset Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetOptionValueInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetOptionValueInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Lookups/LookupRegularAssetOptionValueOption": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Lookup the Regular Asset Type Option for the Regular Asset Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Option->Id | integer | int64 |\r\n| code | Option->Code | string | |\r\n| description | Option->Description | string | |\r\n| upperBounds | Option->UpperBounds | string | |\r\n| lowerBounds | Option->LowerBounds | string | |\r\n| dataType | Option->DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| unitOfMeasurementId | Option->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Option->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Option->UnitOfMeasurement_Description | string | |\r\n| optionCategoryId | Option->OptionCategory_Id | integer | int64 |\r\n| optionCategoryCode | Option->OptionCategory_Code | string | |\r\n| optionCategoryDescription | Option->OptionCategory_Description | string | |\r\n| allowMultipleValues | Option->AllowMultipleValues | boolean | |\r\n", "operationId": "LookupRegularAssetOptionValueOption", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Option collection", "schema": { "$ref": "#/definitions/RegularAssetOptionValueOptionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Lookups/LookupRegularAssetOptionValueRegularAsset": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Lookup the Regular Asset Type for the Regular Asset Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetOptionValueRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetOptionValueRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Lookups/LookupRegularAssetOptionValueRegularAssetTypeOptionForLinkedAssetType": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Lookup the Regular Asset Type Option for the Regular Asset Option Value.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTypeOption->Id | integer | int64 |\r\n| optionId | RegularAssetTypeOption->Option_Id | integer | int64 |\r\n| optionCode | RegularAssetTypeOption->Option_Code | string | |\r\n| optionDescription | RegularAssetTypeOption->Option_Description | string | |\r\n| optionUpperBounds | RegularAssetTypeOption->Option_UpperBounds | string | |\r\n| optionLowerBounds | RegularAssetTypeOption->Option_LowerBounds | string | |\r\n| optionDataType | RegularAssetTypeOption->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\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| 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| optionAllowMultipleValues | RegularAssetTypeOption->Option_AllowMultipleValues | boolean | |\r\n", "operationId": "LookupRegularAssetOptionValueRegularAssetTypeOptionForLinkedAssetType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Batch/{ids}": { "get": { "tags": [ "Regular Asset Option Value" ], "summary": "Get a collection of Regular Asset Option Value resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| isCustom | RegularAssetOptionValue->IsCustom | boolean | |\r\n| optionId | RegularAssetOptionValue->Option_Id | integer | int64 |\r\n| optionAllowMultipleValues | RegularAssetOptionValue->Option_AllowMultipleValues | boolean | |\r\n| optionCode | RegularAssetOptionValue->Option_Code | string | |\r\n| optionDataType | RegularAssetOptionValue->Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| optionDescription | RegularAssetOptionValue->Option_Description | string | |\r\n| optionLowerBounds | RegularAssetOptionValue->Option_LowerBounds | string | |\r\n| optionUpperBounds | RegularAssetOptionValue->Option_UpperBounds | string | |\r\n| optionOptionCategoryId | RegularAssetOptionValue->Option_OptionCategory_Id | integer | int64 |\r\n| optionOptionCategoryCode | RegularAssetOptionValue->Option_OptionCategory_Code | string | |\r\n| optionOptionCategoryDescription | RegularAssetOptionValue->Option_OptionCategory_Description | string | |\r\n| optionUnitOfMeasurementId | RegularAssetOptionValue->Option_UnitOfMeasurement_Id | integer | int64 |\r\n| optionUnitOfMeasurementCode | RegularAssetOptionValue->Option_UnitOfMeasurement_Code | string | |\r\n| optionUnitOfMeasurementDescription | RegularAssetOptionValue->Option_UnitOfMeasurement_Description | string | |\r\n| regularAssetTypeOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Option_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_Code | string | |\r\n| regularAssetTypeOptionOptionDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_Description | string | |\r\n| regularAssetTypeOptionOptionAllowMultipleValues | RegularAssetOptionValue->RegularAssetTypeOption_Option_AllowMultipleValues | boolean | |\r\n| regularAssetTypeOptionOptionLowerBounds | RegularAssetOptionValue->RegularAssetTypeOption_Option_LowerBounds | string | |\r\n| regularAssetTypeOptionOptionDataType | RegularAssetOptionValue->RegularAssetTypeOption_Option_DataType | string (Allowed values: [String, Integer, Float, DateTime, Boolean]) | enum |\r\n| regularAssetTypeOptionOptionUpperBounds | RegularAssetOptionValue->RegularAssetTypeOption_Option_UpperBounds | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryId | RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionOptionCategoryCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Code | string | |\r\n| regularAssetTypeOptionOptionOptionCategoryDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Description | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementId | RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Id | integer | int64 |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementCode | RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Code | string | |\r\n| regularAssetTypeOptionOptionUnitOfMeasurementDescription | RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Description | string | |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| isActive | RegularAssetOptionValue->IsActive | boolean | |\r\n| createdByUserId | RegularAssetOptionValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetOptionValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetOptionValue->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetOptionValue->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetOptionValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetOptionValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetOptionValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetOptionValue->ModifiedOn | string | date-time |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetOptionValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetOptionValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetOptionValue->PermissionTree_Description | string | |\r\n| notes | RegularAssetOptionValue->Notes | string | |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| regularAssetId | RegularAssetOptionValue->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetOptionValue->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetOptionValue->RegularAsset_Description | string | |\r\n", "operationId": "BatchGetRegularAssetOptionValue", "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 Option Value id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Option Value collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetOptionValueResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Batch": { "post": { "tags": [ "Regular Asset Option Value" ], "summary": "Create a new collection of Regular Asset Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RegularAssetOptionValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| regularAssetId | RegularAssetOptionValue->RegularAsset_Id | integer | int64 |\r\n| regularAssetTypeOptionId | RegularAssetOptionValue->RegularAssetTypeOption_Id | integer | int64 |\r\n| optionId | RegularAssetOptionValue->Option_Id | integer | int64 |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| notes | RegularAssetOptionValue->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | Min Value | > 0| |\r\n| regularAssetTypeOptionId | Min Value | > 0| |\r\n| optionId | Nullable | False | |\r\n| optionValue | Required | True | |\r\n| optionValue | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetOptionValue", "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/BatchCreateRegularAssetOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset Option Value batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Option Value" ], "summary": "Update a collection of existing Regular Asset Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetOptionValue->SequenceNumber | integer | int32 |\r\n| optionValue | RegularAssetOptionValue->OptionValue | string | |\r\n| notes | RegularAssetOptionValue->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateRegularAssetOptionValue", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Option Value batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Option Value" ], "summary": "Delete a collection of existing Regular Asset Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| version | RegularAssetOptionValue->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": "BatchDeleteRegularAssetOptionValue", "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/BatchDeleteRegularAssetOptionValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Option Value batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/{id}/Active": { "patch": { "tags": [ "Regular Asset Option Value" ], "summary": "Change the IsActive status for an existing Regular Asset Option Value resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| isActive | RegularAssetOptionValue->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": "ChangeRegularAssetOptionValueIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Option Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetOptionValueIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/OptionValues/Batch/Active": { "patch": { "tags": [ "Regular Asset Option Value" ], "summary": "Change the IsActive status for a collection of existing Regular Asset Option Value resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetOptionValue->Id | integer | int64 |\r\n| version | RegularAssetOptionValue->Version | integer | int32 |\r\n| isActive | RegularAssetOptionValue->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": "BatchChangeRegularAssetOptionValueIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetOptionValueIsActiveResourceActionRequest" } }, { "$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/RegularAssets/Responsibilities/{id}": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Get a Regular Asset 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 | RegularAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetResponsibility->Id | integer | int64 |\r\n| isActive | RegularAssetResponsibility->IsActive | boolean | |\r\n| isHistorical | RegularAssetResponsibility->IsHistorical | boolean | |\r\n| isInherited | RegularAssetResponsibility->IsInherited | boolean | |\r\n| isProposed | RegularAssetResponsibility->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetResponsibility->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetResponsibility->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetResponsibility->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetResponsibility->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetResponsibility->ModifiedOn | string | date-time |\r\n| version | RegularAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetResponsibility->Notes | string | |\r\n| recordType | RegularAssetResponsibility->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetResponsibility->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetResponsibility->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetResponsibility->RegularAsset_Description | string | |\r\n| resourceId | RegularAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | RegularAssetResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | RegularAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetResponsibility->Section_Code | string | |\r\n| sectionDescription | RegularAssetResponsibility->Section_Description | string | |\r\n| tradeId | RegularAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetResponsibility->Trade_Code | string | |\r\n| tradeDescription | RegularAssetResponsibility->Trade_Description | string | |\r\n", "operationId": "GetRegularAssetResponsibility", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Responsibility", "schema": { "$ref": "#/definitions/GetRegularAssetResponsibilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Responsibility" ], "summary": "Update an existing Regular Asset 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 | RegularAssetResponsibility->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetResponsibility->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n| tradeId | Nullable | False | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Section_Id eq NULL |\r\n| resourceId | Nullable | False | RegularAssetResponsibility->Section_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "UpdateRegularAssetResponsibility", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Responsibility" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetResponsibility->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": "DeleteRegularAssetResponsibility", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Responsibility 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/RegularAssets/Responsibilities": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetResponsibility->Id | integer | int64 |\r\n| version | RegularAssetResponsibility->Version | integer | int32 |\r\n| isActive | RegularAssetResponsibility->IsActive | boolean | |\r\n| regularAssetCode | RegularAssetResponsibility->RegularAsset_Code | string | |\r\n| tradeCode | RegularAssetResponsibility->Trade_Code | string | |\r\n| sectionCode | RegularAssetResponsibility->Section_Code | string | |\r\n| resourceCode | RegularAssetResponsibility->Resource_Code | string | |\r\n| inheritedFromId | RegularAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| isInherited | RegularAssetResponsibility->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n", "operationId": "GetRegularAssetResponsibilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Responsibility collection", "schema": { "$ref": "#/definitions/GetRegularAssetResponsibilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Responsibility" ], "summary": "Create a new Regular Asset 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| permissionTreeId | RegularAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| regularAssetId | RegularAssetResponsibility->RegularAsset_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetResponsibility->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Nullable | False | |\r\n| sectionId | Nullable | False | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n| tradeId | Nullable | False | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Section_Id eq NULL |\r\n| resourceId | Nullable | False | RegularAssetResponsibility->Section_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "CreateRegularAssetResponsibility", "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/CreateRegularAssetResponsibilityResourceActionRequest" } }, { "$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/RegularAssets/{id}/Responsibilities": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Get a collection of responsibility resources for the Regular Asset.", "description": "### Response Body\r\n#### 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 | RegularAssetResponsibility->Version | integer | int32 |\r\n| id | RegularAssetResponsibility->Id | integer | int64 |\r\n| resourceId | RegularAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetResponsibility->Resource_Code | string | |\r\n| tradeId | RegularAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetResponsibility->Trade_Code | string | |\r\n| sectionId | RegularAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetResponsibility->Section_Code | string | |\r\n| notes | RegularAssetResponsibility->Notes | string | |\r\n| developmentStatus | RegularAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetResponsibility->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetResponsibilityForRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Responsibility collection", "schema": { "$ref": "#/definitions/GetRegularAssetResponsibilityForRegularAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Lookups/LookupRegularAssetResponsibilityChangePermissionTree": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetResponsibilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetResponsibilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Lookups/LookupRegularAssetResponsibilityInsertPermissionTree": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetResponsibilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Lookups/LookupRegularAssetResponsibilityRegularAsset": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Lookup the Regular Asset for the Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetResponsibilityRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetResponsibilityRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Lookups/LookupRegularAssetResponsibilityResource": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Lookup the Resource for the Regular Asset 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": "LookupRegularAssetResponsibilityResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetResponsibilityResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Lookups/LookupRegularAssetResponsibilityResourceWithTradeFilter": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Lookup the Resource for the Regular Asset 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": "LookupRegularAssetResponsibilityResourceWithTradeFilter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Lookups/LookupRegularAssetResponsibilitySection": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Lookup the Section for the Regular Asset 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": "LookupRegularAssetResponsibilitySection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetResponsibilitySectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Lookups/LookupRegularAssetResponsibilityTrade": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Lookup the Trade for the Regular Asset 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": "LookupRegularAssetResponsibilityTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetResponsibilityTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Batch/{ids}": { "get": { "tags": [ "Regular Asset Responsibility" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetResponsibility->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetResponsibility->Id | integer | int64 |\r\n| isActive | RegularAssetResponsibility->IsActive | boolean | |\r\n| isHistorical | RegularAssetResponsibility->IsHistorical | boolean | |\r\n| isInherited | RegularAssetResponsibility->IsInherited | boolean | |\r\n| isProposed | RegularAssetResponsibility->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetResponsibility->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetResponsibility->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetResponsibility->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetResponsibility->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetResponsibility->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetResponsibility->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetResponsibility->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetResponsibility->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetResponsibility->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetResponsibility->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetResponsibility->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetResponsibility->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetResponsibility->ModifiedOn | string | date-time |\r\n| version | RegularAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetResponsibility->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetResponsibility->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetResponsibility->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetResponsibility->Notes | string | |\r\n| recordType | RegularAssetResponsibility->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetResponsibility->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetResponsibility->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetResponsibility->RegularAsset_Description | string | |\r\n| resourceId | RegularAssetResponsibility->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetResponsibility->Resource_Code | string | |\r\n| resourceContactDetailId | RegularAssetResponsibility->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetResponsibility->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetResponsibility->Resource_ContactDetailLastName | string | |\r\n| sectionId | RegularAssetResponsibility->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetResponsibility->Section_Code | string | |\r\n| sectionDescription | RegularAssetResponsibility->Section_Description | string | |\r\n| tradeId | RegularAssetResponsibility->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetResponsibility->Trade_Code | string | |\r\n| tradeDescription | RegularAssetResponsibility->Trade_Description | string | |\r\n", "operationId": "BatchGetRegularAssetResponsibility", "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 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 Responsibility collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetResponsibilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Batch": { "post": { "tags": [ "Regular Asset Responsibility" ], "summary": "Create a new collection of Regular Asset 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| permissionTreeId | RegularAssetResponsibility->PermissionTree_Id | integer | int64 |\r\n| regularAssetId | RegularAssetResponsibility->RegularAsset_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetResponsibility->Notes | string | |\r\n\r\n#### Business 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| regularAssetId | Nullable | False | |\r\n| sectionId | Nullable | False | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n| tradeId | Nullable | False | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Section_Id eq NULL |\r\n| resourceId | Nullable | False | RegularAssetResponsibility->Section_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "BatchCreateRegularAssetResponsibility", "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/BatchCreateRegularAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Responsibility" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetResponsibility->Id | integer | int64 |\r\n| version | RegularAssetResponsibility->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetResponsibility->SequenceNumber | integer | int32 |\r\n| sectionId | RegularAssetResponsibility->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetResponsibility->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetResponsibility->Resource_Id | integer | int64 |\r\n| notes | RegularAssetResponsibility->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n| tradeId | Nullable | False | RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Section_Id eq NULL |\r\n| resourceId | Nullable | False | RegularAssetResponsibility->Section_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL |\r\n\r\n", "operationId": "BatchUpdateRegularAssetResponsibility", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Responsibility" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetResponsibility->Id | integer | int64 |\r\n| version | RegularAssetResponsibility->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetResponsibility", "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/BatchDeleteRegularAssetResponsibilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Responsibility 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/RegularAssets/Responsibilities/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Responsibility" ], "summary": "Accept the Development Status for an existing Regular Asset Responsibility resource.", "description": "", "operationId": "AcceptRegularAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Responsibility" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Responsibility resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Responsibility id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Responsibility" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Responsibility resource id's.", "description": "", "operationId": "BatchRejectRegularAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Responsibility id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/{id}/Active": { "patch": { "tags": [ "Regular Asset Responsibility" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetResponsibility->Version | integer | int32 |\r\n| isActive | RegularAssetResponsibility->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": "ChangeRegularAssetResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetResponsibilityIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Responsibility" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetResponsibility->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": "ChangeRegularAssetResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetResponsibilityPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Responsibility" ], "summary": "Reject the Development Status for an existing Regular Asset Responsibility resource.", "description": "", "operationId": "RejectRegularAssetResponsibilityDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Responsibility Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Responsibilities/Batch/Active": { "patch": { "tags": [ "Regular Asset Responsibility" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetResponsibility->Id | integer | int64 |\r\n| version | RegularAssetResponsibility->Version | integer | int32 |\r\n| isActive | RegularAssetResponsibility->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": "BatchChangeRegularAssetResponsibilityIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetResponsibilityIsActiveResourceActionRequest" } }, { "$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/RegularAssets/Responsibilities/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Responsibility" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetResponsibility->Id | integer | int64 |\r\n| version | RegularAssetResponsibility->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetResponsibility->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": "BatchChangeRegularAssetResponsibilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetResponsibilityPermissionTreeResourceActionRequest" } }, { "$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/RegularAssets/Spares/{id}": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Get a Regular Asset 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 | RegularAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetSpare->Id | integer | int64 |\r\n| isActive | RegularAssetSpare->IsActive | boolean | |\r\n| isHistorical | RegularAssetSpare->IsHistorical | boolean | |\r\n| isInherited | RegularAssetSpare->IsInherited | boolean | |\r\n| isProposed | RegularAssetSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetSpare->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromMaterialMasterId | RegularAssetSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | RegularAssetSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | RegularAssetSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetSpare->MaterialMaster_Description | string | |\r\n| notes | RegularAssetSpare->Notes | string | |\r\n| recordType | RegularAssetSpare->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetSpare->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetSpare->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetSpare->RegularAsset_Description | string | |\r\n", "operationId": "GetRegularAssetSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Spare", "schema": { "$ref": "#/definitions/GetRegularAssetSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Spare" ], "summary": "Update an existing Regular Asset 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 | RegularAssetSpare->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| notes | RegularAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| materialMasterId | Nullable | False | |\r\n\r\n", "operationId": "UpdateRegularAssetSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Spare was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Spare" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetSpare->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": "DeleteRegularAssetSpare", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Spare was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetSpare->Id | integer | int64 |\r\n| version | RegularAssetSpare->Version | integer | int32 |\r\n| regularAssetId | RegularAssetSpare->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetSpare->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetSpare->RegularAsset_Description | string | |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetSpare->MaterialMaster_Description | string | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| developmentStatus | RegularAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetSpare->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Spare collection", "schema": { "$ref": "#/definitions/GetRegularAssetSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Spare" ], "summary": "Create a new Regular Asset 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| regularAssetId | RegularAssetSpare->RegularAsset_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| notes | RegularAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | 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": "CreateRegularAssetSpare", "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/CreateRegularAssetSpareResourceActionRequest" } }, { "$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/RegularAssets/{id}/Spares": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Get a collection of Regular Asset Spare resources for theRegular Asset.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetSpare->Id | integer | int64 |\r\n| version | RegularAssetSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetSpare->MaterialMaster_Description | string | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| developmentStatus | RegularAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetSpare->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetSpareForRegularAssetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Spare collection", "schema": { "$ref": "#/definitions/GetSpareForRegularAssetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Lookups/LookupRegularAssetSpareChangePermissionTree": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Lookups/LookupRegularAssetSpareInsertPermissionTree": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Lookups/LookupRegularAssetSpareMaterialMaster": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Lookup the Material Master for the Regular Asset 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": "LookupRegularAssetSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Lookups/LookupRegularAssetSpareRegularAsset": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Lookup the Regular Asset for the Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupRegularAssetSpareRegularAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetSpareRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Batch/{ids}": { "get": { "tags": [ "Regular Asset Spare" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetSpare->Id | integer | int64 |\r\n| isActive | RegularAssetSpare->IsActive | boolean | |\r\n| isHistorical | RegularAssetSpare->IsHistorical | boolean | |\r\n| isInherited | RegularAssetSpare->IsInherited | boolean | |\r\n| isProposed | RegularAssetSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetSpare->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetSpare->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetSpare->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromMaterialMasterId | RegularAssetSpare->InheritedFrom_MaterialMaster_Id | integer | int64 |\r\n| inheritedFromMaterialMasterCode | RegularAssetSpare->InheritedFrom_MaterialMaster_Code | string | |\r\n| inheritedFromMaterialMasterDescription | RegularAssetSpare->InheritedFrom_MaterialMaster_Description | string | |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetSpare->MaterialMaster_Description | string | |\r\n| notes | RegularAssetSpare->Notes | string | |\r\n| recordType | RegularAssetSpare->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetId | RegularAssetSpare->RegularAsset_Id | integer | int64 |\r\n| regularAssetCode | RegularAssetSpare->RegularAsset_Code | string | |\r\n| regularAssetDescription | RegularAssetSpare->RegularAsset_Description | string | |\r\n", "operationId": "BatchGetRegularAssetSpare", "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 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 Spare collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Batch": { "post": { "tags": [ "Regular Asset Spare" ], "summary": "Create a new collection of Regular Asset 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| regularAssetId | RegularAssetSpare->RegularAsset_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetSpare->PermissionTree_Id | integer | int64 |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| notes | RegularAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetId | Required | True | |\r\n| regularAssetId | Nullable | False | |\r\n| regularAssetId | 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": "BatchCreateRegularAssetSpare", "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/BatchCreateRegularAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Spare" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetSpare->Id | integer | int64 |\r\n| version | RegularAssetSpare->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetSpare->SequenceNumber | integer | int32 |\r\n| isCritical | RegularAssetSpare->IsCritical | boolean | |\r\n| isEmergency | RegularAssetSpare->IsEmergency | boolean | |\r\n| materialMasterId | RegularAssetSpare->MaterialMaster_Id | integer | int64 |\r\n| notes | RegularAssetSpare->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| materialMasterId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetSpare", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Spare batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Spare" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetSpare->Id | integer | int64 |\r\n| version | RegularAssetSpare->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetSpare", "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/BatchDeleteRegularAssetSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Spare batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Spare" ], "summary": "Accept the Development Status for an existing Regular Asset Spare resource.", "description": "", "operationId": "AcceptRegularAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Spare" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Spare resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Spare" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Spare resource id's.", "description": "", "operationId": "BatchRejectRegularAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/{id}/Active": { "patch": { "tags": [ "Regular Asset Spare" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetSpare->Version | integer | int32 |\r\n| isActive | RegularAssetSpare->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": "ChangeRegularAssetSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetSpareIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Spare" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetSpare->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": "ChangeRegularAssetSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetSparePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Spare" ], "summary": "Reject the Development Status for an existing Regular Asset Spare resource.", "description": "", "operationId": "RejectRegularAssetSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssets/Spares/Batch/Active": { "patch": { "tags": [ "Regular Asset Spare" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetSpare->Id | integer | int64 |\r\n| version | RegularAssetSpare->Version | integer | int32 |\r\n| isActive | RegularAssetSpare->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": "BatchChangeRegularAssetSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetSpareIsActiveResourceActionRequest" } }, { "$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/RegularAssets/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Spare" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetSpare->Id | integer | int64 |\r\n| version | RegularAssetSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetSpare->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": "BatchChangeRegularAssetSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetSparePermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/{id}": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Get a Regular Asset 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| ruleEvaluationFailedReason | RegularAssetTask->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetTask->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTask->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | RegularAssetTask->Unsubscribed | boolean | |\r\n| code | RegularAssetTask->Code | string | |\r\n| createdByUserId | RegularAssetTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTask->PermissionTree_Description | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetRecordType | RegularAssetTask->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetAssetTypeId | RegularAssetTask->Asset_AssetType_Id | integer | int64 |\r\n| assetAssetTypeRecordType | RegularAssetTask->Asset_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetNearestRegularAssetId | RegularAssetTask->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetTreePathId | RegularAssetTask->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | RegularAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentRecordType | RegularAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| componentQuantity | RegularAssetTask->Component_Quantity | integer | int32 |\r\n| componentTreePathId | RegularAssetTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | RegularAssetTask->Component_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTask->Id | integer | int64 |\r\n| isActive | RegularAssetTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTask->Unsynchronised | boolean | |\r\n| siteId | RegularAssetTask->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetTask->Site_Code | string | |\r\n| siteDescription | RegularAssetTask->Site_Description | string | |\r\n| actualInterval1 | RegularAssetTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | RegularAssetTask->ActualInterval2 | number | decimal |\r\n| allowConditions | RegularAssetTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetTypeId | RegularAssetTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTask->AssetType_Description | string | |\r\n| autoCalculateDowntimePerUnit | RegularAssetTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| daysToScheduleOn | RegularAssetTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTask->DefaultInterval2_Description | string | |\r\n| derivedFromStandardTask | RegularAssetTask->DerivedFromStandardTask | boolean | |\r\n| description | RegularAssetTask->Description | string | |\r\n| detailEvaluationPassReason | RegularAssetTask->DetailEvaluationPassReason | string (Allowed values: [AllTypeCollectionsEmpty, ExcludeSparesTickOffWithNonDCItems, ExcludeSpecialResourceTickOffWithNonDCItems, ExcludeFollowUpTaskTickOffWithNonDCItems, SomeSparesEvalTrue, SomeSpecialResourcesEvalTrue, SomeFollowUpTasksEvalTrue]) | enum |\r\n| downtimePerUnit | RegularAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTask->DurationPerUnit | string | duration |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| eventId | RegularAssetTask->Event_Id | integer | int64 |\r\n| eventCode | RegularAssetTask->Event_Code | string | |\r\n| eventDescription | RegularAssetTask->Event_Description | string | |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| importanceCode | RegularAssetTask->Importance_Code | string | |\r\n| importanceDescription | RegularAssetTask->Importance_Description | string | |\r\n| inheritedFromId | RegularAssetTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | RegularAssetTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | RegularAssetTask->InheritedFrom_Description | string | |\r\n| inheritedFromLastConfirmedOn | RegularAssetTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromRecordType | RegularAssetTask->InheritedFrom_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| inheritedFromAssetTypeId | RegularAssetTask->InheritedFrom_AssetType_Id | integer | int64 |\r\n| inheritedFromAssetTypeCode | RegularAssetTask->InheritedFrom_AssetType_Code | string | |\r\n| inheritedFromAssetTypeDescription | RegularAssetTask->InheritedFrom_AssetType_Description | string | |\r\n| inspectionType | RegularAssetTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTask->IntervalType1_Description | string | |\r\n| intervalType1SchedulingKind | RegularAssetTask->IntervalType1_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTask->IntervalType2_Description | string | |\r\n| intervalType2SchedulingKind | RegularAssetTask->IntervalType2_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isDisabledByCondition | RegularAssetTask->IsDisabledByCondition | boolean | |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| isInitialised | RegularAssetTask->IsInitialised | boolean | |\r\n| isInitialisedFailReasons | RegularAssetTask->IsInitialisedFailReasons | array | enum |\r\n| isInOpenWorkOrder | RegularAssetTask->IsInOpenWorkOrder | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isPausedForScheduling | RegularAssetTask->IsPausedForScheduling | boolean | |\r\n| isReadyForScheduling | RegularAssetTask->IsReadyForScheduling | boolean | |\r\n| isStatutory | RegularAssetTask->IsStatutory | boolean | |\r\n| isSuppressed | RegularAssetTask->IsSuppressed | boolean | |\r\n| isSuppressedErrors | RegularAssetTask->IsSuppressedErrors | array | enum |\r\n| isSuppressor | RegularAssetTask->IsSuppressor | boolean | |\r\n| isSuppressorErrors | RegularAssetTask->IsSuppressorErrors | array | enum |\r\n| labourDurationCalculationType | RegularAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| lastDoneCumulativeMeterReading | RegularAssetTask->LastDoneCumulativeMeterReading | number | decimal |\r\n| lastScheduledServiceDate | RegularAssetTask->LastScheduledServiceDate | string | date |\r\n| lastScheduledServiceMeterReading | RegularAssetTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastServiceDate | RegularAssetTask->LastServiceDate | string | date |\r\n| lastServiceMeterReading | RegularAssetTask->LastServiceMeterReading | number | decimal |\r\n| latestWorkOrderTaskId | RegularAssetTask->LatestWorkOrderTask_Id | integer | int64 |\r\n| latestWorkOrderTaskAssetTreePathId | RegularAssetTask->LatestWorkOrderTask_AssetTreePathId | integer | int64 |\r\n| latestWorkOrderTaskAssetTreePathItems | RegularAssetTask->LatestWorkOrderTask_AssetTreePathItems | array | array |\r\n| latestWorkOrderTaskComponentTreePathId | RegularAssetTask->LatestWorkOrderTask_ComponentTreePathId | integer | int64 |\r\n| latestWorkOrderTaskComponentTreePathItems | RegularAssetTask->LatestWorkOrderTask_ComponentTreePathItems | array | array |\r\n| latestWorkOrderTaskCompleted | RegularAssetTask->LatestWorkOrderTask_Completed | boolean | |\r\n| latestWorkOrderTaskTaskCode | RegularAssetTask->LatestWorkOrderTask_TaskCode | string | |\r\n| latestWorkOrderTaskTaskDescription | RegularAssetTask->LatestWorkOrderTask_TaskDescription | string | |\r\n| latestWorkOrderTaskTaskType | RegularAssetTask->LatestWorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| longDescription | RegularAssetTask->LongDescription | string | |\r\n| machineState | RegularAssetTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetTask->Meter_Code | string | |\r\n| meterDescription | RegularAssetTask->Meter_Description | string | |\r\n| meterLastReadOn | RegularAssetTask->Meter_LastReadOn | string | date-time |\r\n| meterLastReading | RegularAssetTask->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | RegularAssetTask->Meter_AverageDailyRate | number | decimal |\r\n| monitoringPointId | RegularAssetTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | RegularAssetTask->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | RegularAssetTask->MonitoringPoint_Description | string | |\r\n| monitoringPointTypeId | RegularAssetTask->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | RegularAssetTask->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | RegularAssetTask->MonitoringPointType_Description | string | |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| pausedReason | RegularAssetTask->PausedReason | string | |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| recordType | RegularAssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | RegularAssetTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | RegularAssetTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | RegularAssetTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceContactDetailId | RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | RegularAssetTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | RegularAssetTask->ResponsibleTrade_Description | string | |\r\n| schedulingFailReasons | RegularAssetTask->SchedulingFailReasons | array | enum |\r\n| schedulingMethod | RegularAssetTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| taskClassification1Id | RegularAssetTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | RegularAssetTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | RegularAssetTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | RegularAssetTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | RegularAssetTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | RegularAssetTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | RegularAssetTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | RegularAssetTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | RegularAssetTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | RegularAssetTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | RegularAssetTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | RegularAssetTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | RegularAssetTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | RegularAssetTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | RegularAssetTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | RegularAssetTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | RegularAssetTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | RegularAssetTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | RegularAssetTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | RegularAssetTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | RegularAssetTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | RegularAssetTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | RegularAssetTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | RegularAssetTask->TaskClassification8_Description | string | |\r\n| taskRollUpPointId | RegularAssetTask->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAssetTask->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAssetTask->TaskRollUpPoint_Description | string | |\r\n| totalDowntime | RegularAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | RegularAssetTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | RegularAssetTask->TypeOfWork_Description | string | |\r\n", "operationId": "GetRegularAssetTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task", "schema": { "$ref": "#/definitions/GetRegularAssetTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTask->Version | integer | int32 |\r\n| allowConditions | RegularAssetTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| autoCalculateDowntimePerUnit | RegularAssetTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTask->Code | string | |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTask->DurationPerUnit | string | duration |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| typeOfWorkId | RegularAssetTask->TypeOfWork_Id | integer | int64 |\r\n| eventId | RegularAssetTask->Event_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isPausedForScheduling | RegularAssetTask->IsPausedForScheduling | boolean | |\r\n| machineState | RegularAssetTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| monitoringPointId | RegularAssetTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointTypeId | RegularAssetTask->MonitoringPointType_Id | integer | int64 |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| isStatutory | RegularAssetTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | RegularAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTask->LongDescription | string | |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| pausedReason | RegularAssetTask->PausedReason | string | |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | RegularAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTask->TotalDuration | string | duration |\r\n| lastServiceDate | RegularAssetTask->LastServiceDate | string | date |\r\n| lastScheduledServiceDate | RegularAssetTask->LastScheduledServiceDate | string | date |\r\n| lastServiceMeterReading | RegularAssetTask->LastServiceMeterReading | number | decimal |\r\n| lastScheduledServiceMeterReading | RegularAssetTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastDoneCumulativeMeterReading | RegularAssetTask->LastDoneCumulativeMeterReading | number | decimal |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\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| assetId | Nullable | False | |\r\n| assetId | Min Value | > 0| |\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 | RegularAssetTask->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 | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTask->IsDualScheduling eq FALSE |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | RegularAssetTask->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| failedReasonRequired | Nullable | False | RegularAssetTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| isInspection | Nullable | False | |\r\n| isInspection | Read-only | True | RegularAssetTask->IsInherited eq TRUE |\r\n| inspectionType | Nullable | False | RegularAssetTask->IsInspection eq TRUE |\r\n| isMandatory | Nullable | False | |\r\n| isNonUsageBasedReadingRequired | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| monitoringPointId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | False | RegularAssetTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTask->InspectionType eq 'ManualMonitoring' |\r\n| motionType | Nullable | False | |\r\n| isStatutory | Nullable | False | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| pausedReason | Nullable | False | RegularAssetTask->IsPausedForScheduling eq TRUE |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n\r\n", "operationId": "UpdateRegularAssetTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTask->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": "DeleteRegularAssetTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/{regularAssetTaskId}/DueTasks": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Get a collection of Due Task resources for the Regular Asset 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 | DueTask->Id | integer | int64 |\r\n| version | DueTask->Version | integer | int32 |\r\n| generatedOn | DueTask->GeneratedOn | string | date |\r\n| dueDate | DueTask->DueDate | string | date |\r\n| dueReading | DueTask->DueReading | number | decimal |\r\n| interval1DueDate | DueTask->Interval1DueDate | string | date |\r\n| interval2DueDate | DueTask->Interval2DueDate | string | date |\r\n| isSuppressed | DueTask->IsSuppressed | boolean | |\r\n| outOfBoundsTask | DueTask->OutOfBoundsTask | boolean | |\r\n", "operationId": "GetRegularAssetTaskDueTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTaskId", "in": "path", "required": true, "description": "Regular Asset 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 Task collection", "schema": { "$ref": "#/definitions/GetDueTaskForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isInherited | RegularAssetTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTask->InheritedFrom_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| developmentStatus | RegularAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetTreePathItems | RegularAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| componentRecordType | RegularAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentTreePathItems | RegularAssetTask->Component_TreePathItems | array | array |\r\n| defaultInterval1Code | RegularAssetTask->DefaultInterval1_Code | string | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTask->RulesLastEvaluatedOn | string | date-time |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| importanceCode | RegularAssetTask->Importance_Code | string | |\r\n| importanceDescription | RegularAssetTask->Importance_Description | string | |\r\n| ruleEvaluationPassed | RegularAssetTask->RuleEvaluationPassed | boolean | |\r\n| siteId | RegularAssetTask->Site_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTask->IntervalType1_Description | string | |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTask->IntervalType2_Description | string | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n", "operationId": "GetRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task" ], "summary": "Create a new Regular Asset 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| allowConditions | RegularAssetTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| autoCalculateDowntimePerUnit | RegularAssetTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTask->Code | string | |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTask->DurationPerUnit | string | duration |\r\n| eventId | RegularAssetTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isStatutory | RegularAssetTask->IsStatutory | boolean | |\r\n| isPausedForScheduling | RegularAssetTask->IsPausedForScheduling | boolean | |\r\n| labourDurationCalculationType | RegularAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTask->LongDescription | string | |\r\n| machineState | RegularAssetTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| monitoringPointId | RegularAssetTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointTypeId | RegularAssetTask->MonitoringPointType_Id | integer | int64 |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| pausedReason | RegularAssetTask->PausedReason | string | |\r\n| permissionTreeId | RegularAssetTask->PermissionTree_Id | integer | int64 |\r\n| siteId | RegularAssetTask->Site_Id | integer | int64 |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | RegularAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTask->TypeOfWork_Id | integer | int64 |\r\n| lastServiceDate | RegularAssetTask->LastServiceDate | string | date |\r\n| lastScheduledServiceDate | RegularAssetTask->LastScheduledServiceDate | string | date |\r\n| lastServiceMeterReading | RegularAssetTask->LastServiceMeterReading | number | decimal |\r\n| lastScheduledServiceMeterReading | RegularAssetTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastDoneCumulativeMeterReading | RegularAssetTask->LastDoneCumulativeMeterReading | number | decimal |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| allowConditions | Nullable | False | |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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 | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTask->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| failedReasonRequired | Nullable | False | RegularAssetTask->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| isDualScheduling | Required | True | |\r\n| isDualScheduling | Nullable | False | |\r\n| isInspection | Required | True | |\r\n| isInspection | Nullable | False | |\r\n| inspectionType | Nullable | False | RegularAssetTask->IsInspection eq TRUE |\r\n| isMandatory | Required | True | |\r\n| isMandatory | Nullable | False | |\r\n| isNonUsageBasedReadingRequired | Required | True | |\r\n| isNonUsageBasedReadingRequired | Nullable | False | |\r\n| isStatutory | Required | True | |\r\n| isStatutory | Nullable | False | |\r\n| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| monitoringPointId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | False | RegularAssetTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTask->InspectionType eq 'ManualMonitoring' |\r\n| motionType | Required | True | |\r\n| motionType | Nullable | False | |\r\n| pausedReason | Nullable | False | RegularAssetTask->IsPausedForScheduling eq TRUE |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n| typeOfWorkId | Required | True | |\r\n| typeOfWorkId | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTask", "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/CreateRegularAssetTaskResourceActionRequest" } }, { "$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/RegularAssetTasks/Lookups/LookupCreateFromStandardTaskAssetComponentFromAsset": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Asset Component for the Regular Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| assetId | AssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | AssetComponent->Asset_Code | string | |\r\n| assetDescription | AssetComponent->Asset_Description | string | |\r\n", "operationId": "LookupCreateFromStandardTaskAssetComponentFromAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/StandardTaskAssetComponentFromAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupCreateFromStandardTaskAssetComponent": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Asset Component for the Regular Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| assetId | AssetComponent->Asset_Id | integer | int64 |\r\n| assetCode | AssetComponent->Asset_Code | string | |\r\n| assetDescription | AssetComponent->Asset_Description | string | |\r\n", "operationId": "LookupCreateFromStandardTaskAssetComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/StandardTaskAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupCreateFromStandardTaskAsset": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Asset for the Regular Asset 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 | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n", "operationId": "LookupCreateFromStandardTaskAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset collection", "schema": { "$ref": "#/definitions/StandardTaskAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskDefaultInterval1": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Task Interval for the Regular Asset 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": "LookupRegularAssetTaskDefaultInterval1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskDefaultInterval1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskDefaultInterval2": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Task Interval for the Regular Asset 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": "LookupRegularAssetTaskDefaultInterval2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskDefaultInterval2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskEvent": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Event for the Regular Asset 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": "LookupRegularAssetTaskEvent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskImportance": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Task Importance for the Regular Asset 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": "LookupRegularAssetTaskImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskIntervalType1": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Task Interval Type for the Regular Asset 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": "LookupRegularAssetTaskIntervalType1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskIntervalType1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskIntervalType2": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Task Interval Type for the Regular Asset 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": "LookupRegularAssetTaskIntervalType2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskIntervalType2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskMeterAll": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Meter for the Regular Asset 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 | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskMeterAll", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/RegularAssetTaskMeterAllLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskMeter": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Meter for the Regular Asset 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 | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Meter collection", "schema": { "$ref": "#/definitions/RegularAssetTaskMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskMonitoringPoint": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Monitoring Point for the Regular Asset 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 | MonitoringPoint->Id | integer | int64 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskMonitoringPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 collection", "schema": { "$ref": "#/definitions/RegularAssetTaskMonitoringPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskMonitoringPointType": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Monitoring Point Type for the Regular Asset 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": "LookupRegularAssetTaskMonitoringPointType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskMonitoringPointTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskComponent": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Asset Component for the Regular Asset 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 | AssetComponent->Id | integer | int64 |\r\n| code | AssetComponent->Code | string | |\r\n| description | AssetComponent->Description | string | |\r\n| quantity | AssetComponent->Quantity | integer | int32 |\r\n", "operationId": "LookupRegularAssetTaskComponent", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Component collection", "schema": { "$ref": "#/definitions/RegularAssetTaskRegularAssetComponentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskAsset": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset for the Regular Asset 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 | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n| recordType | RegularAsset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupRegularAssetTaskAsset", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset collection", "schema": { "$ref": "#/definitions/RegularAssetTaskRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskResponsibleSection": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Section for the Regular Asset 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": "LookupRegularAssetTaskResponsibleSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResponsibleSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskResponsibleStaffMemberResource": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Resource for the Regular Asset 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| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupRegularAssetTaskResponsibleStaffMemberResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskResponsibleTrade": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Trade for the Regular Asset 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": "LookupRegularAssetTaskResponsibleTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResponsibleTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskSite": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Site for the Regular Asset 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/RegularAssetTaskSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification1": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification1", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification1LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification2": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification2", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification2LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification3": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification3", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification3LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification4": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification4", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification4LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification5": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification5", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification5LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification6": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification6", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification6LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification7": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification7", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification7LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskClassification8": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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": "LookupRegularAssetTaskTaskClassification8", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskClassification8LookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTaskRollUpPoint": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Task Roll Up Point for the Regular Asset 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": "LookupRegularAssetTaskTaskRollUpPoint", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTaskRollUpPointLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Lookups/LookupRegularAssetTaskTypeOfWork": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Lookup the Type of Work for the Regular Asset 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": "LookupRegularAssetTaskTypeOfWork", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskTypeOfWorkLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task" ], "summary": "Get a collection of Regular Asset 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| ruleEvaluationFailedReason | RegularAssetTask->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetTask->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTask->RulesLastEvaluatedOn | string | date-time |\r\n| unsubscribed | RegularAssetTask->Unsubscribed | boolean | |\r\n| code | RegularAssetTask->Code | string | |\r\n| createdByUserId | RegularAssetTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTask->PermissionTree_Description | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| assetCode | RegularAssetTask->Asset_Code | string | |\r\n| assetDescription | RegularAssetTask->Asset_Description | string | |\r\n| assetRecordType | RegularAssetTask->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetAssetTypeId | RegularAssetTask->Asset_AssetType_Id | integer | int64 |\r\n| assetAssetTypeRecordType | RegularAssetTask->Asset_AssetType_RecordType | string (Allowed values: [Folder, Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| assetNearestRegularAssetId | RegularAssetTask->Asset_NearestRegularAsset_Id | integer | int64 |\r\n| assetTreePathId | RegularAssetTask->Asset_TreePathId | integer | int64 |\r\n| assetTreePathItems | RegularAssetTask->Asset_TreePathItems | array | array |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| componentRecordType | RegularAssetTask->Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| componentCode | RegularAssetTask->Component_Code | string | |\r\n| componentDescription | RegularAssetTask->Component_Description | string | |\r\n| componentQuantity | RegularAssetTask->Component_Quantity | integer | int32 |\r\n| componentTreePathId | RegularAssetTask->Component_TreePathId | integer | int64 |\r\n| componentTreePathItems | RegularAssetTask->Component_TreePathItems | array | array |\r\n| developmentStatus | RegularAssetTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTask->Id | integer | int64 |\r\n| isActive | RegularAssetTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTask->Unsynchronised | boolean | |\r\n| siteId | RegularAssetTask->Site_Id | integer | int64 |\r\n| siteCode | RegularAssetTask->Site_Code | string | |\r\n| siteDescription | RegularAssetTask->Site_Description | string | |\r\n| actualInterval1 | RegularAssetTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | RegularAssetTask->ActualInterval2 | number | decimal |\r\n| allowConditions | RegularAssetTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetTypeId | RegularAssetTask->AssetType_Id | integer | int64 |\r\n| assetTypeCode | RegularAssetTask->AssetType_Code | string | |\r\n| assetTypeDescription | RegularAssetTask->AssetType_Description | string | |\r\n| autoCalculateDowntimePerUnit | RegularAssetTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| daysToScheduleOn | RegularAssetTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval1Code | RegularAssetTask->DefaultInterval1_Code | string | |\r\n| defaultInterval1Description | RegularAssetTask->DefaultInterval1_Description | string | |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| defaultInterval2Code | RegularAssetTask->DefaultInterval2_Code | string | |\r\n| defaultInterval2Description | RegularAssetTask->DefaultInterval2_Description | string | |\r\n| derivedFromStandardTask | RegularAssetTask->DerivedFromStandardTask | boolean | |\r\n| description | RegularAssetTask->Description | string | |\r\n| detailEvaluationPassReason | RegularAssetTask->DetailEvaluationPassReason | string (Allowed values: [AllTypeCollectionsEmpty, ExcludeSparesTickOffWithNonDCItems, ExcludeSpecialResourceTickOffWithNonDCItems, ExcludeFollowUpTaskTickOffWithNonDCItems, SomeSparesEvalTrue, SomeSpecialResourcesEvalTrue, SomeFollowUpTasksEvalTrue]) | enum |\r\n| downtimePerUnit | RegularAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTask->DurationPerUnit | string | duration |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| eventId | RegularAssetTask->Event_Id | integer | int64 |\r\n| eventCode | RegularAssetTask->Event_Code | string | |\r\n| eventDescription | RegularAssetTask->Event_Description | string | |\r\n| excludeWhenAllFollowUpTaskRulesFail | RegularAssetTask->ExcludeWhenAllFollowUpTaskRulesFail | boolean | |\r\n| excludeWhenAllSpareRulesFail | RegularAssetTask->ExcludeWhenAllSpareRulesFail | boolean | |\r\n| excludeWhenSpecialResourceRulesFail | RegularAssetTask->ExcludeWhenSpecialResourceRulesFail | boolean | |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| importanceCode | RegularAssetTask->Importance_Code | string | |\r\n| importanceDescription | RegularAssetTask->Importance_Description | string | |\r\n| inheritedFromId | RegularAssetTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | RegularAssetTask->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | RegularAssetTask->InheritedFrom_Description | string | |\r\n| inheritedFromLastConfirmedOn | RegularAssetTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromRecordType | RegularAssetTask->InheritedFrom_RecordType | string (Allowed values: [Regular, StandardTask, Auxiliary]) | enum |\r\n| inheritedFromAssetTypeId | RegularAssetTask->InheritedFrom_AssetType_Id | integer | int64 |\r\n| inheritedFromAssetTypeCode | RegularAssetTask->InheritedFrom_AssetType_Code | string | |\r\n| inheritedFromAssetTypeDescription | RegularAssetTask->InheritedFrom_AssetType_Description | string | |\r\n| inspectionType | RegularAssetTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType1Code | RegularAssetTask->IntervalType1_Code | string | |\r\n| intervalType1Description | RegularAssetTask->IntervalType1_Description | string | |\r\n| intervalType1SchedulingKind | RegularAssetTask->IntervalType1_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| intervalType2Code | RegularAssetTask->IntervalType2_Code | string | |\r\n| intervalType2Description | RegularAssetTask->IntervalType2_Description | string | |\r\n| intervalType2SchedulingKind | RegularAssetTask->IntervalType2_SchedulingKind | string (Allowed values: [AdHoc, Calendar, Event, Usage]) | enum |\r\n| isDisabledByCondition | RegularAssetTask->IsDisabledByCondition | boolean | |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| isInitialised | RegularAssetTask->IsInitialised | boolean | |\r\n| isInitialisedFailReasons | RegularAssetTask->IsInitialisedFailReasons | array | enum |\r\n| isInOpenWorkOrder | RegularAssetTask->IsInOpenWorkOrder | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isPausedForScheduling | RegularAssetTask->IsPausedForScheduling | boolean | |\r\n| isReadyForScheduling | RegularAssetTask->IsReadyForScheduling | boolean | |\r\n| isStatutory | RegularAssetTask->IsStatutory | boolean | |\r\n| isSuppressed | RegularAssetTask->IsSuppressed | boolean | |\r\n| isSuppressedErrors | RegularAssetTask->IsSuppressedErrors | array | enum |\r\n| isSuppressor | RegularAssetTask->IsSuppressor | boolean | |\r\n| isSuppressorErrors | RegularAssetTask->IsSuppressorErrors | array | enum |\r\n| labourDurationCalculationType | RegularAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| lastDoneCumulativeMeterReading | RegularAssetTask->LastDoneCumulativeMeterReading | number | decimal |\r\n| lastScheduledServiceDate | RegularAssetTask->LastScheduledServiceDate | string | date |\r\n| lastScheduledServiceMeterReading | RegularAssetTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastServiceDate | RegularAssetTask->LastServiceDate | string | date |\r\n| lastServiceMeterReading | RegularAssetTask->LastServiceMeterReading | number | decimal |\r\n| latestWorkOrderTaskId | RegularAssetTask->LatestWorkOrderTask_Id | integer | int64 |\r\n| latestWorkOrderTaskAssetTreePathId | RegularAssetTask->LatestWorkOrderTask_AssetTreePathId | integer | int64 |\r\n| latestWorkOrderTaskAssetTreePathItems | RegularAssetTask->LatestWorkOrderTask_AssetTreePathItems | array | array |\r\n| latestWorkOrderTaskComponentTreePathId | RegularAssetTask->LatestWorkOrderTask_ComponentTreePathId | integer | int64 |\r\n| latestWorkOrderTaskComponentTreePathItems | RegularAssetTask->LatestWorkOrderTask_ComponentTreePathItems | array | array |\r\n| latestWorkOrderTaskCompleted | RegularAssetTask->LatestWorkOrderTask_Completed | boolean | |\r\n| latestWorkOrderTaskTaskCode | RegularAssetTask->LatestWorkOrderTask_TaskCode | string | |\r\n| latestWorkOrderTaskTaskDescription | RegularAssetTask->LatestWorkOrderTask_TaskDescription | string | |\r\n| latestWorkOrderTaskTaskType | RegularAssetTask->LatestWorkOrderTask_TaskType | string (Allowed values: [RegularAssetTask, RegularAssetTaskFollowUpTask, StandardTask]) | enum |\r\n| longDescription | RegularAssetTask->LongDescription | string | |\r\n| machineState | RegularAssetTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| meterCode | RegularAssetTask->Meter_Code | string | |\r\n| meterDescription | RegularAssetTask->Meter_Description | string | |\r\n| meterLastReadOn | RegularAssetTask->Meter_LastReadOn | string | date-time |\r\n| meterLastReading | RegularAssetTask->Meter_LastReading | number | decimal |\r\n| meterAverageDailyRate | RegularAssetTask->Meter_AverageDailyRate | number | decimal |\r\n| monitoringPointId | RegularAssetTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | RegularAssetTask->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | RegularAssetTask->MonitoringPoint_Description | string | |\r\n| monitoringPointTypeId | RegularAssetTask->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | RegularAssetTask->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | RegularAssetTask->MonitoringPointType_Description | string | |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| pausedReason | RegularAssetTask->PausedReason | string | |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| recordType | RegularAssetTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleSectionCode | RegularAssetTask->ResponsibleSection_Code | string | |\r\n| responsibleSectionDescription | RegularAssetTask->ResponsibleSection_Description | string | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleStaffMemberResourceCode | RegularAssetTask->ResponsibleStaffMemberResource_Code | string | |\r\n| responsibleStaffMemberResourceContactDetailId | RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailId | integer | int64 |\r\n| responsibleStaffMemberResourceContactDetailFirstName | RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailFirstName | string | |\r\n| responsibleStaffMemberResourceContactDetailLastName | RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailLastName | string | |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| responsibleTradeCode | RegularAssetTask->ResponsibleTrade_Code | string | |\r\n| responsibleTradeDescription | RegularAssetTask->ResponsibleTrade_Description | string | |\r\n| schedulingFailReasons | RegularAssetTask->SchedulingFailReasons | array | enum |\r\n| schedulingMethod | RegularAssetTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| taskClassification1Id | RegularAssetTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | RegularAssetTask->TaskClassification1_Code | string | |\r\n| taskClassification1Description | RegularAssetTask->TaskClassification1_Description | string | |\r\n| taskClassification2Id | RegularAssetTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | RegularAssetTask->TaskClassification2_Code | string | |\r\n| taskClassification2Description | RegularAssetTask->TaskClassification2_Description | string | |\r\n| taskClassification3Id | RegularAssetTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | RegularAssetTask->TaskClassification3_Code | string | |\r\n| taskClassification3Description | RegularAssetTask->TaskClassification3_Description | string | |\r\n| taskClassification4Id | RegularAssetTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | RegularAssetTask->TaskClassification4_Code | string | |\r\n| taskClassification4Description | RegularAssetTask->TaskClassification4_Description | string | |\r\n| taskClassification5Id | RegularAssetTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | RegularAssetTask->TaskClassification5_Code | string | |\r\n| taskClassification5Description | RegularAssetTask->TaskClassification5_Description | string | |\r\n| taskClassification6Id | RegularAssetTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | RegularAssetTask->TaskClassification6_Code | string | |\r\n| taskClassification6Description | RegularAssetTask->TaskClassification6_Description | string | |\r\n| taskClassification7Id | RegularAssetTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | RegularAssetTask->TaskClassification7_Code | string | |\r\n| taskClassification7Description | RegularAssetTask->TaskClassification7_Description | string | |\r\n| taskClassification8Id | RegularAssetTask->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | RegularAssetTask->TaskClassification8_Code | string | |\r\n| taskClassification8Description | RegularAssetTask->TaskClassification8_Description | string | |\r\n| taskRollUpPointId | RegularAssetTask->TaskRollUpPoint_Id | integer | int64 |\r\n| taskRollUpPointCode | RegularAssetTask->TaskRollUpPoint_Code | string | |\r\n| taskRollUpPointDescription | RegularAssetTask->TaskRollUpPoint_Description | string | |\r\n| totalDowntime | RegularAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTask->TypeOfWork_Id | integer | int64 |\r\n| typeOfWorkCode | RegularAssetTask->TypeOfWork_Code | string | |\r\n| typeOfWorkDescription | RegularAssetTask->TypeOfWork_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTask", "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 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 Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Create a new collection of Regular Asset 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| actualInterval1 | RegularAssetTask->ActualInterval1 | number | decimal |\r\n| actualInterval2 | RegularAssetTask->ActualInterval2 | number | decimal |\r\n| allowConditions | RegularAssetTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| autoCalculateDowntimePerUnit | RegularAssetTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTask->Code | string | |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTask->DurationPerUnit | string | duration |\r\n| eventId | RegularAssetTask->Event_Id | integer | int64 |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| isDisabledByCondition | RegularAssetTask->IsDisabledByCondition | boolean | |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isStatutory | RegularAssetTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | RegularAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTask->LongDescription | string | |\r\n| machineState | RegularAssetTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| monitoringPointId | RegularAssetTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointTypeId | RegularAssetTask->MonitoringPointType_Id | integer | int64 |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTask->PermissionTree_Id | integer | int64 |\r\n| siteId | RegularAssetTask->Site_Id | integer | int64 |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | RegularAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTask->TotalDuration | string | duration |\r\n| typeOfWorkId | RegularAssetTask->TypeOfWork_Id | integer | int64 |\r\n| lastServiceDate | RegularAssetTask->LastServiceDate | string | date |\r\n| lastScheduledServiceDate | RegularAssetTask->LastScheduledServiceDate | string | date |\r\n| lastServiceMeterReading | RegularAssetTask->LastServiceMeterReading | number | decimal |\r\n| lastScheduledServiceMeterReading | RegularAssetTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastDoneCumulativeMeterReading | RegularAssetTask->LastDoneCumulativeMeterReading | number | decimal |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n| pausedReason | RegularAssetTask->PausedReason | string | |\r\n| isPausedForScheduling | RegularAssetTask->IsPausedForScheduling | 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| allowConditions | Nullable | False | |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetId | Required | True | |\r\n| assetId | Nullable | False | |\r\n| assetId | 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 | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTask->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| failedReasonRequired | Nullable | False | RegularAssetTask->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| isDisabledByCondition | Nullable | 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 | RegularAssetTask->IsInspection eq TRUE |\r\n| isMandatory | Required | True | |\r\n| isMandatory | Nullable | False | |\r\n| isNonUsageBasedReadingRequired | Required | True | |\r\n| isNonUsageBasedReadingRequired | Nullable | False | |\r\n| isStatutory | Required | True | |\r\n| isStatutory | Nullable | False | |\r\n| labourDurationCalculationType | Required | True | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| monitoringPointId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | False | RegularAssetTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTask->InspectionType eq 'ManualMonitoring' |\r\n| motionType | Required | True | |\r\n| motionType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | System Generated | true | If no value specified |\r\n| siteId | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\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| pausedReason | Nullable | False | RegularAssetTask->IsPausedForScheduling eq TRUE |\r\n\r\n", "operationId": "BatchCreateRegularAssetTask", "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/BatchCreateRegularAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| allowConditions | RegularAssetTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| assetId | RegularAssetTask->Asset_Id | integer | int64 |\r\n| autoCalculateDowntimePerUnit | RegularAssetTask->AutoCalculateDowntimePerUnit | boolean | |\r\n| autoCalculateDurationPerUnit | RegularAssetTask->AutoCalculateDurationPerUnit | boolean | |\r\n| autoCalculateTotalDowntime | RegularAssetTask->AutoCalculateTotalDowntime | boolean | |\r\n| autoCalculateTotalDuration | RegularAssetTask->AutoCalculateTotalDuration | boolean | |\r\n| code | RegularAssetTask->Code | string | |\r\n| componentId | RegularAssetTask->Component_Id | integer | int64 |\r\n| daysToScheduleOn | RegularAssetTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| description | RegularAssetTask->Description | string | |\r\n| downtimePerUnit | RegularAssetTask->DowntimePerUnit | string | duration |\r\n| durationPerUnit | RegularAssetTask->DurationPerUnit | string | duration |\r\n| failedReasonRequired | RegularAssetTask->FailedReasonRequired | boolean | |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| typeOfWorkId | RegularAssetTask->TypeOfWork_Id | integer | int64 |\r\n| eventId | RegularAssetTask->Event_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| isInspection | RegularAssetTask->IsInspection | boolean | |\r\n| inspectionType | RegularAssetTask->InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isNonUsageBasedReadingRequired | RegularAssetTask->IsNonUsageBasedReadingRequired | boolean | |\r\n| isStatutory | RegularAssetTask->IsStatutory | boolean | |\r\n| labourDurationCalculationType | RegularAssetTask->LabourDurationCalculationType | string (Allowed values: [Series, Parallel]) | enum |\r\n| longDescription | RegularAssetTask->LongDescription | string | |\r\n| machineState | RegularAssetTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| notes | RegularAssetTask->Notes | string | |\r\n| printLongDescriptionOnWorkOrder | RegularAssetTask->PrintLongDescriptionOnWorkOrder | boolean | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTask->TaskRollUpPoint_Id | integer | int64 |\r\n| totalDowntime | RegularAssetTask->TotalDowntime | string | duration |\r\n| totalDuration | RegularAssetTask->TotalDuration | string | duration |\r\n| lastServiceDate | RegularAssetTask->LastServiceDate | string | date |\r\n| lastScheduledServiceDate | RegularAssetTask->LastScheduledServiceDate | string | date |\r\n| lastServiceMeterReading | RegularAssetTask->LastServiceMeterReading | number | decimal |\r\n| lastScheduledServiceMeterReading | RegularAssetTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastDoneCumulativeMeterReading | RegularAssetTask->LastDoneCumulativeMeterReading | number | decimal |\r\n| estimatedNextDueMeterReading | RegularAssetTask->EstimatedNextDueMeterReading | number | decimal |\r\n| estimatedNextDueDate | RegularAssetTask->EstimatedNextDueDate | string | date |\r\n| pausedReason | RegularAssetTask->PausedReason | string | |\r\n| isPausedForScheduling | RegularAssetTask->IsPausedForScheduling | boolean | |\r\n| monitoringPointId | RegularAssetTask->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointTypeId | RegularAssetTask->MonitoringPointType_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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| allowConditions | Nullable | False | |\r\n| alternativeDescription | Nullable | False | |\r\n| alternativeDescription | Min Length | >= 1 chars| |\r\n| alternativeDescription | Max Length | <= 255 chars| |\r\n| assetId | Nullable | False | |\r\n| assetId | Min Value | > 0| |\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 | RegularAssetTask->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 | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTask->IsDualScheduling eq FALSE |\r\n| description | Nullable | False | |\r\n| description | Read-only | True | RegularAssetTask->IsInherited eq true |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| failedReasonRequired | Nullable | False | RegularAssetTask->InspectionType eq 'PassOrFail' |\r\n| importanceId | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| isInspection | Nullable | False | |\r\n| isInspection | Read-only | True | RegularAssetTask->IsInherited eq TRUE |\r\n| inspectionType | Nullable | False | RegularAssetTask->IsInspection eq TRUE |\r\n| isMandatory | Nullable | False | |\r\n| isNonUsageBasedReadingRequired | Nullable | False | |\r\n| isStatutory | Nullable | False | |\r\n| labourDurationCalculationType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| motionType | Nullable | False | |\r\n| printLongDescriptionOnWorkOrder | Nullable | False | |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n| totalDowntime | Min Value | >= 00:00:00| |\r\n| totalDuration | Min Value | >= 00:00:00| |\r\n| pausedReason | Nullable | False | RegularAssetTask->IsPausedForScheduling eq TRUE |\r\n| monitoringPointId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | True | RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring' |\r\n| monitoringPointTypeId | Nullable | False | RegularAssetTask->InspectionType eq 'ManualReadingOnly' OR RegularAssetTask->InspectionType eq 'ManualMonitoring' |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->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": "BatchDeleteRegularAssetTask", "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/BatchDeleteRegularAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Accept the Development Status for an existing Regular Asset Task resource.", "description": "", "operationId": "AcceptRegularAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/{ids}/BreakLinkToStandardTask": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Batch break Regular Asset Tasks link to Standard Tasks.", "description": "", "operationId": "BatchBreakRegularAssetTaskLinkToStandardTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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/RegularAssetTasks/Batch/Initialised": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Batch Is Initialised Check Bulk for Regular Asset Tasks", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "BatchCheckIsInitialisedBulk", "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/BatchCheckIsInitialisedBulkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/{assetTaskIds}/Initialised": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Batch Is Initialised Check for Regular Asset Tasks", "description": "", "operationId": "BatchCheckIsInitialised", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "assetTaskIds", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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/RegularAssetTasks/Batch/ReadyForScheduling": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Batch Is Ready For Scheduling Check Bulk for Regular Asset Tasks", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "BatchCheckIsReadyForSchedulingBulk", "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/BatchCheckIsReadyForSchedulingBulkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/{assetTaskIds}/ReadyForScheduling": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Batch Is Ready For Scheduling Check for Regular Asset Tasks", "description": "", "operationId": "BatchCheckIsReadyForScheduling", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "assetTaskIds", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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/RegularAssetTasks/Batch/GenerateDueTasks": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Batch Generate Due Tasks Bulk for Regular Asset Tasks", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "BatchGenerateDueTasksBulk", "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/BatchGenerateDueTasksForRegularAssetTasksBulkResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/{regularAssetTaskIds}/GenerateDueTasks": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Batch Generate Due Tasks for Regular Asset Tasks", "description": "", "operationId": "BatchGenerateDueTasks", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "regularAssetTaskIds", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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/RegularAssetTasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/{ids}/Sync": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Synchronise the collection of existing Regular Asset Task resource id's.", "description": "", "operationId": "BatchSyncRegularAssetTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/{id}/BreakLinkToStandardTask": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Break Regular Asset Task link to Standard Task.", "description": "", "operationId": "BreakRegularAssetTaskLinkToStandardTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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/RegularAssetTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Task" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTask->Version | integer | int32 |\r\n| isActive | RegularAssetTask->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": "ChangeRegularAssetTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTask->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": "ChangeRegularAssetTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/Initialised/{id}": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Check if initialised.", "description": "", "operationId": "CheckIsInitialised", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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/RegularAssetTasks/Scheduling/{id}": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Check if ready for scheduling.", "description": "", "operationId": "CheckIsReadyForScheduling", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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/RegularAssetTasks/CreateFromStandardTask": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Create Regular Asset Task from the Standard 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| assetId | CreateRegularAssetTaskFromStandardTask->Asset_Id | integer | int64 |\r\n| assetComponentId | CreateRegularAssetTaskFromStandardTask->AssetComponent_Id | integer | int64 |\r\n| permissionTreeId | CreateRegularAssetTaskFromStandardTask->PermissionTree_Id | integer | int64 |\r\n| breakStandardTaskLink | CreateRegularAssetTaskFromStandardTask->BreakStandardTaskLink | boolean | |\r\n| keepStandardTaskCode | CreateRegularAssetTaskFromStandardTask->KeepStandardTaskCode | boolean | |\r\n| standardTaskIds | CreateRegularAssetTaskFromStandardTask->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| assetId | Required | True | |\r\n| assetId | 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": "CreateRegularAssetTaskFromStandardTask", "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/CreateRegularAssetTaskFromStandardTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/GenerateDueTasks/{id}": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Generate Due Tasks.", "description": "", "operationId": "GenerateDueTasks", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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/RegularAssetTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Reject the Development Status for an existing Regular Asset Task resource.", "description": "", "operationId": "RejectRegularAssetTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Sync/Resubscribe": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Accept the Development Status for an existing Regular Asset 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| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "ResubscribeRegularAssetTaskDevelopmentStatus", "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/ResubscribeRegularAssetTaskDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/{id}/Sync": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Synchronise the existing Regular Asset Task resource.", "description": "", "operationId": "SyncRegularAssetTask", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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": "string", "name": "syncMessage", "in": "query", "description": "Message to use for the Sync background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Sync/Unsubscribe": { "post": { "tags": [ "Regular Asset Task" ], "summary": "Accept the Development Status for an existing Regular Asset 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| ids | IdListEntity->Ids | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| ids | Required | True | |\r\n| ids | Nullable | False | |\r\n\r\n", "operationId": "UnsubscribeRegularAssetTaskDevelopmentStatus", "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/UnsubscribeRegularAssetTaskDevelopmentStatusResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the development status operation (default=True)", "x-nullable": true }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| isActive | RegularAssetTask->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": "BatchChangeRegularAssetTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTask->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": "BatchChangeRegularAssetTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/MatchBatch": { "patch": { "tags": [ "Regular Asset Task" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| version | RegularAssetTask->Version | integer | int32 |\r\n| allowConditions | RegularAssetTask->AllowConditions | boolean | |\r\n| alternativeDescription | RegularAssetTask->AlternativeDescription | string | |\r\n| daysToScheduleOn | RegularAssetTask->DaysToScheduleOn | string (Allowed values: [WorkingDays, NonWorkingDays, WorkingAndNonWorkingDays]) | enum |\r\n| defaultInterval1Id | RegularAssetTask->DefaultInterval1_Id | integer | int64 |\r\n| defaultInterval2Id | RegularAssetTask->DefaultInterval2_Id | integer | int64 |\r\n| importanceId | RegularAssetTask->Importance_Id | integer | int64 |\r\n| typeOfWorkId | RegularAssetTask->TypeOfWork_Id | integer | int64 |\r\n| eventId | RegularAssetTask->Event_Id | integer | int64 |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| intervalType2Id | RegularAssetTask->IntervalType2_Id | integer | int64 |\r\n| isDualScheduling | RegularAssetTask->IsDualScheduling | boolean | |\r\n| isMandatory | RegularAssetTask->IsMandatory | boolean | |\r\n| isPausedForScheduling | RegularAssetTask->IsPausedForScheduling | boolean | |\r\n| motionType | RegularAssetTask->MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| machineState | RegularAssetTask->MachineState | string (Allowed values: [RunningOrNotRunning, OnlyNotRunning, OnlyRunning]) | enum |\r\n| isStatutory | RegularAssetTask->IsStatutory | boolean | |\r\n| meterId | RegularAssetTask->Meter_Id | integer | int64 |\r\n| pausedReason | RegularAssetTask->PausedReason | string | |\r\n| responsibleStaffMemberResourceId | RegularAssetTask->ResponsibleStaffMemberResource_Id | integer | int64 |\r\n| responsibleSectionId | RegularAssetTask->ResponsibleSection_Id | integer | int64 |\r\n| responsibleTradeId | RegularAssetTask->ResponsibleTrade_Id | integer | int64 |\r\n| schedulingMethod | RegularAssetTask->SchedulingMethod | string (Allowed values: [LastScheduled, LastDone]) | enum |\r\n| sequenceNumber | RegularAssetTask->SequenceNumber | integer | int32 |\r\n| taskClassification1Id | RegularAssetTask->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | RegularAssetTask->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | RegularAssetTask->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | RegularAssetTask->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | RegularAssetTask->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | RegularAssetTask->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | RegularAssetTask->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | RegularAssetTask->TaskClassification8_Id | integer | int64 |\r\n| taskRollUpPointId | RegularAssetTask->TaskRollUpPoint_Id | integer | int64 |\r\n| lastServiceDate | RegularAssetTask->LastServiceDate | string | date |\r\n| lastServiceMeterReading | RegularAssetTask->LastServiceMeterReading | number | decimal |\r\n| lastScheduledServiceMeterReading | RegularAssetTask->LastScheduledServiceMeterReading | number | decimal |\r\n| lastScheduledServiceDate | RegularAssetTask->LastScheduledServiceDate | string | date |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| 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 | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | False | RegularAssetTask->IsDualScheduling eq TRUE |\r\n| defaultInterval2Id | Nullable | True | RegularAssetTask->IsDualScheduling eq FALSE |\r\n| importanceId | Nullable | False | |\r\n| typeOfWorkId | Nullable | False | |\r\n| intervalType1Id | Nullable | False | |\r\n| isMandatory | Nullable | False | |\r\n| motionType | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| machineState | Nullable | False | |\r\n| isStatutory | Nullable | False | |\r\n| pausedReason | Nullable | False | RegularAssetTask->IsPausedForScheduling eq TRUE |\r\n| taskRollUpPointId | Min Value | > 0| |\r\n\r\n", "operationId": "MatchUpdateRegularAssetTask", "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/MatchUpdateRegularAssetTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTasks/Attributes/{id}": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Get a collection of Regular Asset Task Attribute resources for the Regular Asset 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| inheritedFrom | RegularAssetTaskAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskAttribute | RegularAssetTaskAttribute->InheritedFromStandardTaskAttribute | boolean | |\r\n| regularAssetTaskId | RegularAssetTaskAttribute->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskAttribute->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskAttribute->RegularAssetTask_Description | string | |\r\n| developmentStatus | RegularAssetTaskAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | RegularAssetTaskAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | RegularAssetTaskAttribute->IsHistorical | boolean | |\r\n| unsynchronised | RegularAssetTaskAttribute->Unsynchronised | boolean | |\r\n| isInherited | RegularAssetTaskAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTaskAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTaskAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTaskAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| id | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTaskAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTaskAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTaskAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n", "operationId": "GetRegularAssetTaskAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Attribute", "schema": { "$ref": "#/definitions/GetRegularAssetTaskAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetTaskAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskAttribute->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": "DeleteRegularAssetTaskAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/{regularAssetTaskId}/Attributes": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Get a collection of Regular Asset Task Attribute resources for the Regular Asset 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 | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTaskAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTaskAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTaskAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n| createdOn | RegularAssetTaskAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskAttributeCollectionForRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTaskId", "in": "path", "required": true, "description": "Regular Asset 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 Task Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskAttributeCollectionForRegularAssetTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| regularAssetTaskCode | RegularAssetTaskAttribute->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskAttribute->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAlternativeDescription | RegularAssetTaskAttribute->RegularAssetTask_AlternativeDescription | string | |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTaskAttribute->IsInherited | boolean | |\r\n| attributeId | RegularAssetTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTaskAttribute->Attribute_Description | string | |\r\n| attributeDataType | RegularAssetTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTaskAttribute->PredefinedValue_Value | object | composite |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n| createdOn | RegularAssetTaskAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Attribute collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskAttribute->RegularAssetTask_Id | integer | int64 |\r\n| attributeId | RegularAssetTaskAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | 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": "CreateRegularAssetTaskAttribute", "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/CreateRegularAssetTaskAttributeResourceActionRequest" } }, { "$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/RegularAssetTasks/Attributes/Lookups/LookupRegularAssetTaskAttributeAllowedValue": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Regular Asset 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": "LookupRegularAssetTaskAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Lookups/LookupRegularAssetTaskAttribute": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Lookup the Attribute for the Regular Asset 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": "LookupRegularAssetTaskAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Lookups/LookupRegularAssetTaskAttributeChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Lookups/LookupRegularAssetTaskAttributeInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Lookups/LookupRegularAssetTaskAttributeRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Lookup the Regular Asset Task Attribute for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskAttributeRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskAttributeRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Get a collection of Regular Asset 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| inheritedFrom | RegularAssetTaskAttribute->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskAttribute | RegularAssetTaskAttribute->InheritedFromStandardTaskAttribute | boolean | |\r\n| regularAssetTaskId | RegularAssetTaskAttribute->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskAttribute->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskAttribute->RegularAssetTask_Description | string | |\r\n| developmentStatus | RegularAssetTaskAttribute->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isProposed | RegularAssetTaskAttribute->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskAttribute->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskAttribute->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskAttribute->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| isHistorical | RegularAssetTaskAttribute->IsHistorical | boolean | |\r\n| unsynchronised | RegularAssetTaskAttribute->Unsynchronised | boolean | |\r\n| isInherited | RegularAssetTaskAttribute->IsInherited | boolean | |\r\n| createdByUserId | RegularAssetTaskAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskAttribute->CreatedOn | string | date-time |\r\n| isActive | RegularAssetTaskAttribute->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTaskAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskAttribute->PermissionTree_Description | string | |\r\n| version | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| id | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| attributeId | RegularAssetTaskAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | RegularAssetTaskAttribute->Attribute_Code | string | |\r\n| attributeDescription | RegularAssetTaskAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | RegularAssetTaskAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | RegularAssetTaskAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | RegularAssetTaskAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | RegularAssetTaskAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | RegularAssetTaskAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n", "operationId": "BatchGetRegularAssetTaskAttribute", "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 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 Task Attribute collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Batch": { "post": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Create a new collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskAttribute->RegularAssetTask_Id | integer | int64 |\r\n| attributeId | RegularAssetTaskAttribute->Attribute_Id | integer | int64 |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | 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": "BatchCreateRegularAssetTaskAttribute", "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/BatchCreateRegularAssetTaskAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Attribute" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| value | RegularAssetTaskAttribute->Value | object | composite |\r\n| predefinedValueId | RegularAssetTaskAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskAttribute->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchUpdateRegularAssetTaskAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTaskAttribute->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": "BatchDeleteRegularAssetTaskAttribute", "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/BatchDeleteRegularAssetTaskAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Accept the Development Status for an existing Regular Asset Task Attribute resource.", "description": "", "operationId": "AcceptRegularAssetTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Attribute resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Attribute resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTaskAttribute->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": "ChangeRegularAssetTaskAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskAttributeIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskAttribute->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": "ChangeRegularAssetTaskAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskAttributePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Reject the Development Status for an existing Regular Asset Task Attribute resource.", "description": "", "operationId": "RejectRegularAssetTaskAttributeDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Attribute Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Attributes/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| isActive | RegularAssetTaskAttribute->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": "BatchChangeRegularAssetTaskAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskAttributeIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskAttribute->Id | integer | int64 |\r\n| version | RegularAssetTaskAttribute->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskAttribute->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": "BatchChangeRegularAssetTaskAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskAttributePermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/AuxiliaryTasks/{id}": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskAuxiliaryTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskAuxiliaryTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskAuxiliaryTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskAuxiliaryTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskAuxiliaryTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskAuxiliaryTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskAuxiliaryTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskAuxiliaryTask->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskAuxiliaryTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskAuxiliaryTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskAuxiliaryTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskAuxiliaryTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskAuxiliaryTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskAuxiliaryTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskAuxiliaryTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskAuxiliaryTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskAuxiliaryTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskAuxiliaryTask->PermissionTree_Description | string | |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| inheritedFromId | RegularAssetTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskAuxiliaryTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromAuxiliaryTaskId | RegularAssetTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Id | integer | int64 |\r\n| inheritedFromAuxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| notes | RegularAssetTaskAuxiliaryTask->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Description | string | |\r\n", "operationId": "GetRegularAssetTaskAuxiliaryTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Auxiliary Task", "schema": { "$ref": "#/definitions/GetRegularAssetTaskAuxiliaryTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAuxiliaryTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetTaskAuxiliaryTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->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": "DeleteRegularAssetTaskAuxiliaryTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Auxiliary Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| regularAssetTaskId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Description | string | |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| isInherited | RegularAssetTaskAuxiliaryTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskAuxiliaryTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| developmentStatus | RegularAssetTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskAuxiliaryTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskAuxiliaryTask->Unsynchronised | boolean | |\r\n| lastConfirmedOn | RegularAssetTaskAuxiliaryTask->LastConfirmedOn | string | date-time |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n", "operationId": "GetRegularAssetTaskAuxiliaryTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Auxiliary Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskAuxiliaryTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id | integer | int64 |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAuxiliaryTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | 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": "CreateRegularAssetTaskAuxiliaryTask", "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/CreateRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, { "$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/RegularAssetTasks/{id}/AuxiliaryTasks": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Get a collection of Regular Asset Task Auxiliary Task for the Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| developmentStatus | RegularAssetTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTaskAuxiliaryTask->IsInherited | boolean | |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n", "operationId": "GetRegularAssetTaskAuxiliaryTaskForRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Task Auxiliary Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskAuxiliaryTaskForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTaskAuxiliaryTaskAuxiliaryTask": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Lookup the Auxiliary Asset Task for the Regular Asset 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 | AuxiliaryAssetTask->Id | integer | int64 |\r\n| code | AuxiliaryAssetTask->Code | string | |\r\n| description | AuxiliaryAssetTask->Description | string | |\r\n| auxiliaryTaskType | AuxiliaryAssetTask->AuxiliaryTaskType | string (Allowed values: [Pre, Post]) | enum |\r\n| assetNearestRegularAssetId | AuxiliaryAssetTask->Asset_NearestRegularAsset_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTaskAuxiliaryTaskAuxiliaryTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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 Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTaskAuxiliaryTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskAuxiliaryTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTaskAuxiliaryTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskAuxiliaryTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Lookups/LookupRegularAssetTaskAuxiliaryTaskRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| assetNearestRegularAssetId | RegularAssetTask->Asset_NearestRegularAsset_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTaskAuxiliaryTaskRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskAuxiliaryTaskRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetTaskAuxiliaryTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskAuxiliaryTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskAuxiliaryTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskAuxiliaryTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskAuxiliaryTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskAuxiliaryTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskAuxiliaryTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskAuxiliaryTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskAuxiliaryTask->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskAuxiliaryTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskAuxiliaryTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskAuxiliaryTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskAuxiliaryTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskAuxiliaryTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskAuxiliaryTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskAuxiliaryTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskAuxiliaryTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskAuxiliaryTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskAuxiliaryTask->PermissionTree_Description | string | |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code | string | |\r\n| auxiliaryTaskDescription | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description | string | |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| inheritedFromId | RegularAssetTaskAuxiliaryTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskAuxiliaryTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromAuxiliaryTaskId | RegularAssetTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Id | integer | int64 |\r\n| inheritedFromAuxiliaryTaskCode | RegularAssetTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Code | string | |\r\n| inheritedFromRegularAssetTypeTaskId | RegularAssetTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskCode | RegularAssetTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Code | string | |\r\n| notes | RegularAssetTaskAuxiliaryTask->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTaskAuxiliaryTask", "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 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 Task Auxiliary Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskAuxiliaryTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Batch": { "post": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Create a new collection of Regular Asset 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| permissionTreeId | RegularAssetTaskAuxiliaryTask->PermissionTree_Id | integer | int64 |\r\n| regularAssetTaskId | RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id | integer | int64 |\r\n| auxiliaryTaskId | RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id | integer | int64 |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAuxiliaryTask->Notes | string | |\r\n\r\n#### Business 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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | > 0| |\r\n| auxiliaryTaskId | Required | True | |\r\n| auxiliaryTaskId | Nullable | False | |\r\n| auxiliaryTaskId | Min Value | > 0| |\r\n| auxiliaryType | Required | True | |\r\n| auxiliaryType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTaskAuxiliaryTask", "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/BatchCreateRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Auxiliary Task" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| auxiliaryType | RegularAssetTaskAuxiliaryTask->AuxiliaryType | string (Allowed values: [Pre, Post]) | enum |\r\n| sequenceNumber | RegularAssetTaskAuxiliaryTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskAuxiliaryTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateRegularAssetTaskAuxiliaryTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetTaskAuxiliaryTask", "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/BatchDeleteRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Auxiliary Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Accept the Development Status for an existing Regular Asset Task Auxiliary Task resource.", "description": "", "operationId": "AcceptRegularAssetTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Auxiliary Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Auxiliary Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Auxiliary Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Auxiliary Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskAuxiliaryTask->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": "ChangeRegularAssetTaskAuxiliaryTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskAuxiliaryTaskIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskAuxiliaryTask->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": "ChangeRegularAssetTaskAuxiliaryTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskAuxiliaryTaskPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Reject the Development Status for an existing Regular Asset Task Auxiliary Task resource.", "description": "", "operationId": "RejectRegularAssetTaskAuxiliaryTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Auxiliary Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/AuxiliaryTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskAuxiliaryTask->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": "BatchChangeRegularAssetTaskAuxiliaryTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskAuxiliaryTaskIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/AuxiliaryTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Auxiliary Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskAuxiliaryTask->Id | integer | int64 |\r\n| version | RegularAssetTaskAuxiliaryTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskAuxiliaryTask->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": "BatchChangeRegularAssetTaskAuxiliaryTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskAuxiliaryTaskPermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/Conditions/{id}": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetTaskCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskCondition->Id | integer | int64 |\r\n| isActive | RegularAssetTaskCondition->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskCondition->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskCondition->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskCondition->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskCondition->PermissionTree_Description | string | |\r\n| activeCondition | RegularAssetTaskCondition->ActiveCondition | boolean | |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTaskCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetTaskCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTaskCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromConditionId | RegularAssetTaskCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | RegularAssetTaskCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | RegularAssetTaskCondition->InheritedFrom_Condition_Description | string | |\r\n| inheritedFromConditionConditionTypeId | RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Id | integer | int64 |\r\n| inheritedFromConditionConditionTypeCode | RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Code | string | |\r\n| inheritedFromConditionConditionTypeDescription | RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Description | string | |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTaskCondition->Interval_Description | string | |\r\n| notes | RegularAssetTaskCondition->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskCondition->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskCondition->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskCondition->RegularAssetTask_Description | string | |\r\n| regularAssetTaskIntervalType1Id | RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id | integer | int64 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "GetRegularAssetTaskCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Condition Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Condition", "schema": { "$ref": "#/definitions/GetRegularAssetTaskConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Condition" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | RegularAssetTaskCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetTaskCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Condition" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskCondition->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": "DeleteRegularAssetTaskCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Condition Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Condition was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/{regularAssetTaskId}/Conditions": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Get a collection of Regular Asset Task Condition resources for the Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskCondition->IsInherited | boolean | |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTaskCondition->Condition_ConditionType_Description | string | |\r\n| conditionCode | RegularAssetTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTaskCondition->Condition_Description | string | |\r\n| developmentStatus | RegularAssetTaskCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| isActive | RegularAssetTaskCondition->IsActive | boolean | |\r\n| activeCondition | RegularAssetTaskCondition->ActiveCondition | boolean | |\r\n", "operationId": "GetRegularAssetTaskConditionForRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTaskId", "in": "path", "required": true, "description": "Regular Asset 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 Task Condition collection", "schema": { "$ref": "#/definitions/GetConditionForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| regularAssetTaskId | RegularAssetTaskCondition->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskCondition->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskCondition->RegularAssetTask_Description | string | |\r\n| regularAssetTaskIntervalType1Id | RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id | integer | int64 |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| conditionConditionTypeId | RegularAssetTaskCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTaskCondition->Condition_ConditionType_Description | string | |\r\n| conditionCode | RegularAssetTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTaskCondition->Condition_Description | string | |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| isInherited | RegularAssetTaskCondition->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| developmentStatus | RegularAssetTaskCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskCondition->Unsynchronised | boolean | |\r\n| lastConfirmedOn | RegularAssetTaskCondition->LastConfirmedOn | string | date-time |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTaskCondition->Interval_Description | string | |\r\n| activeCondition | RegularAssetTaskCondition->ActiveCondition | boolean | |\r\n", "operationId": "GetRegularAssetTaskConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Condition" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskCondition->RegularAssetTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| notes | RegularAssetTaskCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| adjustmentFactor | System Generated | true | If no value specified |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | System Generated | true | If no value specified |\r\n\r\n", "operationId": "CreateRegularAssetTaskCondition", "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/CreateRegularAssetTaskConditionResourceActionRequest" } }, { "$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/RegularAssetTasks/Conditions/{parentNodeType}/{parentId}/Recursive": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Get a collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskCondition->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskAssetId | RegularAssetTaskCondition->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetCode | RegularAssetTaskCondition->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskAssetDescription | RegularAssetTaskCondition->RegularAssetTask_Asset_Description | string | |\r\n| regularAssetTaskAssetTreePathItems | RegularAssetTaskCondition->RegularAssetTask_Asset_TreePathItems | array | array |\r\n| regularAssetTaskComponentId | RegularAssetTaskCondition->RegularAssetTask_Component_Id | integer | int64 |\r\n| regularAssetTaskComponentCode | RegularAssetTaskCondition->RegularAssetTask_Component_Code | string | |\r\n| regularAssetTaskComponentDescription | RegularAssetTaskCondition->RegularAssetTask_Component_Description | string | |\r\n| regularAssetTaskComponentTreePathItems | RegularAssetTaskCondition->RegularAssetTask_Component_TreePathItems | array | array |\r\n| regularAssetTaskVersion | RegularAssetTaskCondition->RegularAssetTask_Version | integer | int32 |\r\n| regularAssetTaskPermissionTreeId | RegularAssetTaskCondition->RegularAssetTask_PermissionTree_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskCondition->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskCondition->RegularAssetTask_Description | string | |\r\n| regularAssetTaskIntervalType1Id | RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id | integer | int64 |\r\n| regularAssetTaskIntervalType1Code | RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Code | string | |\r\n| regularAssetTaskIntervalType2Code | RegularAssetTaskCondition->RegularAssetTask_IntervalType2_Code | string | |\r\n| regularAssetTaskActualInterval1 | RegularAssetTaskCondition->RegularAssetTask_ActualInterval1 | number | decimal |\r\n| regularAssetTaskActualInterval2 | RegularAssetTaskCondition->RegularAssetTask_ActualInterval2 | number | decimal |\r\n| regularAssetTaskAllowConditions | RegularAssetTaskCondition->RegularAssetTask_AllowConditions | boolean | |\r\n| regularAssetTaskIsDisabledByCondition | RegularAssetTaskCondition->RegularAssetTask_IsDisabledByCondition | boolean | |\r\n| regularAssetTaskMotionType | RegularAssetTaskCondition->RegularAssetTask_MotionType | string (Allowed values: [StationaryOrInMotion, OnlyWhenStationary, OnlyWhenInMotion]) | enum |\r\n| id | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTaskCondition->Condition_Description | string | |\r\n| activeCondition | RegularAssetTaskCondition->ActiveCondition | boolean | |\r\n", "operationId": "GetRegularAssetTaskConditionsRecursiveForParent", "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 Task Condition collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskConditionsRecursiveForParentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Lookups/LookupRegularAssetTaskConditionAllTaskInterval": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Lookup the Task Interval for the Regular Asset 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": "LookupRegularAssetTaskConditionAllTaskInterval", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskConditionAllTaskIntervalLookupRResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Lookups/LookupRegularAssetTaskConditionChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskConditionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Lookups/LookupRegularAssetTaskConditionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskConditionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Lookups/LookupRegularAssetTaskConditionRegularAssetCondition": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Lookup the Regular Asset Condition for the Regular Asset 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": "LookupRegularAssetTaskConditionRegularAssetCondition", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskConditionRegularAssetConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Lookups/LookupRegularAssetTaskConditionRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Lookup the Regular Asset Task for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| intervalType1Id | RegularAssetTask->IntervalType1_Id | integer | int64 |\r\n| assetNearestRegularAssetId | RegularAssetTask->Asset_NearestRegularAsset_Id | integer | int64 |\r\n", "operationId": "LookupRegularAssetTaskConditionRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskConditionRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Lookups/LookupRegularAssetTaskConditionTaskInterval": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Lookup the Task Interval for the Regular Asset 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": "LookupRegularAssetTaskConditionTaskInterval", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskConditionTaskIntervalLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Condition" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetTaskCondition->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskCondition->Id | integer | int64 |\r\n| isActive | RegularAssetTaskCondition->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskCondition->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskCondition->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskCondition->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskCondition->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskCondition->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskCondition->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskCondition->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskCondition->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskCondition->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskCondition->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskCondition->PermissionTree_Description | string | |\r\n| activeCondition | RegularAssetTaskCondition->ActiveCondition | boolean | |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| conditionCode | RegularAssetTaskCondition->Condition_Code | string | |\r\n| conditionDescription | RegularAssetTaskCondition->Condition_Description | string | |\r\n| conditionConditionTypeId | RegularAssetTaskCondition->Condition_ConditionType_Id | integer | int64 |\r\n| conditionConditionTypeCode | RegularAssetTaskCondition->Condition_ConditionType_Code | string | |\r\n| conditionConditionTypeDescription | RegularAssetTaskCondition->Condition_ConditionType_Description | string | |\r\n| inheritedFromId | RegularAssetTaskCondition->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskCondition->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromConditionId | RegularAssetTaskCondition->InheritedFrom_Condition_Id | integer | int64 |\r\n| inheritedFromConditionCode | RegularAssetTaskCondition->InheritedFrom_Condition_Code | string | |\r\n| inheritedFromConditionDescription | RegularAssetTaskCondition->InheritedFrom_Condition_Description | string | |\r\n| inheritedFromConditionConditionTypeId | RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Id | integer | int64 |\r\n| inheritedFromConditionConditionTypeCode | RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Code | string | |\r\n| inheritedFromConditionConditionTypeDescription | RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Description | string | |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| intervalCode | RegularAssetTaskCondition->Interval_Code | string | |\r\n| intervalDescription | RegularAssetTaskCondition->Interval_Description | string | |\r\n| notes | RegularAssetTaskCondition->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskCondition->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskCondition->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskCondition->RegularAssetTask_Description | string | |\r\n| regularAssetTaskIntervalType1Id | RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id | integer | int64 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n", "operationId": "BatchGetRegularAssetTaskCondition", "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 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 Task Condition collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Batch": { "post": { "tags": [ "Regular Asset Task Condition" ], "summary": "Create a new collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskCondition->RegularAssetTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskCondition->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| conditionId | RegularAssetTaskCondition->Condition_Id | integer | int64 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| notes | RegularAssetTaskCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| adjustmentFactor | System Generated | true | If no value specified |\r\n| conditionId | Required | True | |\r\n| conditionId | Nullable | False | |\r\n| state | System Generated | true | If no value specified |\r\n\r\n", "operationId": "BatchCreateRegularAssetTaskCondition", "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/BatchCreateRegularAssetTaskConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Condition" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | RegularAssetTaskCondition->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateRegularAssetTaskCondition", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Condition" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->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| id | Min Value | > 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetTaskCondition", "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/BatchDeleteRegularAssetTaskConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Condition batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Condition" ], "summary": "Accept the Development Status for an existing Regular Asset Task Condition resource.", "description": "", "operationId": "AcceptRegularAssetTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Condition" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Condition resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Condition" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Condition resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Condition id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Condition" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskCondition->Version | integer | int32 |\r\n| isActive | RegularAssetTaskCondition->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": "ChangeRegularAssetTaskConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskConditionIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Condition" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskCondition->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": "ChangeRegularAssetTaskConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Condition Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskConditionPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Condition" ], "summary": "Reject the Development Status for an existing Regular Asset Task Condition resource.", "description": "", "operationId": "RejectRegularAssetTaskConditionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Condition Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Conditions/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Condition" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| isActive | RegularAssetTaskCondition->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": "BatchChangeRegularAssetTaskConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskConditionIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/Conditions/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Condition" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskCondition->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": "BatchChangeRegularAssetTaskConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskConditionPermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/Conditions/MatchBatch": { "patch": { "tags": [ "Regular Asset Task Condition" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskCondition->Id | integer | int64 |\r\n| version | RegularAssetTaskCondition->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskCondition->SequenceNumber | integer | int32 |\r\n| adjustmentFactor | RegularAssetTaskCondition->AdjustmentFactor | number | decimal |\r\n| intervalId | RegularAssetTaskCondition->Interval_Id | integer | int64 |\r\n| state | RegularAssetTaskCondition->State | string (Allowed values: [Apply, Unaffected, Disabled]) | enum |\r\n| notes | RegularAssetTaskCondition->Notes | string | |\r\n\r\n#### Business Rules\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": "MatchUpdateRegularAssetTaskCondition", "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/MatchUpdateRegularAssetTaskConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTasks/Documents/{id}": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Get a collection of Regular Asset Task Document resources for the Regular Asset 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| copyDocumentLink | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| inheritedFrom | RegularAssetTaskDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskDocument | RegularAssetTaskDocument->InheritedFromStandardTaskDocument | boolean | |\r\n| regularAssetTaskId | RegularAssetTaskDocument->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskDocument->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskDocument->RegularAssetTask_Description | string | |\r\n| developmentStatus | RegularAssetTaskDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | RegularAssetTaskDocument->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskDocument->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskDocument->Unsynchronised | boolean | |\r\n| isActive | RegularAssetTaskDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTaskDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRegularAssetTaskDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Document", "schema": { "$ref": "#/definitions/GetRegularAssetTaskDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Document" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n\r\n#### Business 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": "UpdateRegularAssetTaskDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Document" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskDocument->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": "DeleteRegularAssetTaskDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTasks/{id}/Documents": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Get a collection of Regular Asset Task Document resources for the Regular Asset 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 | RegularAssetTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTaskDocument->IsInherited | boolean | |\r\n| copyDocumentLink | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | RegularAssetTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n| createdOn | RegularAssetTaskDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskDocumentCollectionForRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Task Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskDocumentCollectionForRegularAssetTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| regularAssetTaskCode | RegularAssetTaskDocument->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskDocument->RegularAssetTask_Description | string | |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTaskDocument->IsInherited | boolean | |\r\n| copyDocumentLink | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | RegularAssetTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | RegularAssetTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | RegularAssetTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | RegularAssetTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n| createdOn | RegularAssetTaskDocument->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskDocument->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Document collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Document" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskDocument->RegularAssetTask_Id | integer | int64 |\r\n| copyDocumentLink | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | RegularAssetTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | 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": "CreateRegularAssetTaskDocument", "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/CreateRegularAssetTaskDocumentResourceActionRequest" } }, { "$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/RegularAssetTasks/Documents/Lookups/LookupRegularAssetTaskDocumentChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Lookups/LookupRegularAssetTaskDocument": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Lookup the for the Regular Asset 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": "LookupRegularAssetTaskDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Lookups/LookupRegularAssetTaskDocumentInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Lookups/LookupRegularAssetTaskDocumentRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Lookup the Regular Asset Task Document for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskDocumentRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskDocumentRegularAssetLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Document" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| inheritedFrom | RegularAssetTaskDocument->InheritedFrom | integer | int64 |\r\n| inheritedFromStandardTaskDocument | RegularAssetTaskDocument->InheritedFromStandardTaskDocument | boolean | |\r\n| regularAssetTaskId | RegularAssetTaskDocument->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskDocument->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskDocument->RegularAssetTask_Description | string | |\r\n| developmentStatus | RegularAssetTaskDocument->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isHistorical | RegularAssetTaskDocument->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskDocument->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskDocument->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskDocument->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskDocument->LastConfirmedOn | string | date-time |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskDocument->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskDocument->Unsynchronised | boolean | |\r\n| isActive | RegularAssetTaskDocument->IsActive | boolean | |\r\n| createdByUserId | RegularAssetTaskDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskDocument->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskDocument->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskDocument->PermissionTree_Description | string | |\r\n| id | RegularAssetTaskDocument->Id | integer | int64 |\r\n| documentRecordId | RegularAssetTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | RegularAssetTaskDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | RegularAssetTaskDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | RegularAssetTaskDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | RegularAssetTaskDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | RegularAssetTaskDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | RegularAssetTaskDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | RegularAssetTaskDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | RegularAssetTaskDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | RegularAssetTaskDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetTaskDocument", "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 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 Task Document collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Batch": { "post": { "tags": [ "Regular Asset Task Document" ], "summary": "Create a new collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskDocument->RegularAssetTask_Id | integer | int64 |\r\n| copyDocumentLink | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| documentRecordId | RegularAssetTaskDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | 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": "BatchCreateRegularAssetTaskDocument", "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/BatchCreateRegularAssetTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Document" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskDocument->CopyDocumentLink | string (Allowed values: [DoNotCopyLink, CopyLinkToWorkOrders, CopyLinkToWorkOrderTasks]) | enum |\r\n| id | RegularAssetTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskDocument->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskDocument->Notes | string | |\r\n\r\n#### Business 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| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTaskDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Document" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTaskDocument->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": "BatchDeleteRegularAssetTaskDocument", "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/BatchDeleteRegularAssetTaskDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTasks/Documents/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Document" ], "summary": "Accept the Development Status for an existing Regular Asset Task Document resource.", "description": "", "operationId": "AcceptRegularAssetTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Document" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Document resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Document" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Document resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Document" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTaskDocument->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": "ChangeRegularAssetTaskDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskDocumentIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Document" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskDocument->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": "ChangeRegularAssetTaskDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskDocumentPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Document" ], "summary": "Reject the Development Status for an existing Regular Asset Task Document resource.", "description": "", "operationId": "RejectRegularAssetTaskDocumentDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Document Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Documents/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Document" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| isActive | RegularAssetTaskDocument->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": "BatchChangeRegularAssetTaskDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskDocumentIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Document" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskDocument->Id | integer | int64 |\r\n| version | RegularAssetTaskDocument->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskDocument->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": "BatchChangeRegularAssetTaskDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskDocumentPermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/FileAttachments/{id}/Download": { "get": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Download the content for a Regular Asset Task File Attachment resource.", "description": "", "operationId": "GetRegularAssetTaskFileAttachmentContent", "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/RegularAssetTasks/FileAttachments/{id}": { "get": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Get a Regular Asset Task File Attachment resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTaskId | RegularAssetTaskFileAttachment->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskFileAttachment->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFileAttachment->RegularAssetTask_Description | string | |\r\n| createdByUserId | RegularAssetTaskFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RegularAssetTaskFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RegularAssetTaskFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RegularAssetTaskFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RegularAssetTaskFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RegularAssetTaskFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RegularAssetTaskFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RegularAssetTaskFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RegularAssetTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RegularAssetTaskFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RegularAssetTaskFileAttachment->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 | RegularAssetTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTaskFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RegularAssetTaskFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RegularAssetTaskFileAttachment->FileFullName | string | |\r\n| fileName | RegularAssetTaskFileAttachment->FileName | string | |\r\n| fileTypeId | RegularAssetTaskFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RegularAssetTaskFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetTaskFileAttachment->IsRestricted | boolean | |\r\n| id | RegularAssetTaskFileAttachment->Id | integer | int64 |\r\n| isActive | RegularAssetTaskFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTaskFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFileAttachment->PermissionTree_Description | string | |\r\n| version | RegularAssetTaskFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetRegularAssetTaskFileAttachment", "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 Task File Attachment", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Update an existing Regular Asset Task File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTaskFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | RegularAssetTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | RegularAssetTaskFileAttachment->FileName | string | |\r\n| isRestricted | RegularAssetTaskFileAttachment->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": "UpdateRegularAssetTaskFileAttachment", "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/UpdateRegularAssetTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task File Attachment was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Delete an existing Regular Asset Task File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTaskFileAttachment->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": "DeleteRegularAssetTaskFileAttachment", "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/DeleteRegularAssetTaskFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task File Attachment was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/{id}/FileAttachments": { "get": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Get a collection of Regular Asset Task File Attachment resources for the Regular Asset 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 | RegularAssetTaskFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTaskFileAttachment->Version | integer | int32 |\r\n| fileFullName | RegularAssetTaskFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RegularAssetTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | RegularAssetTaskFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RegularAssetTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTaskFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RegularAssetTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RegularAssetTaskFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskFileAttachmentCollectionForRegularAssetTask", "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 Task File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFileAttachmentCollectionForRegularAssetTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FileAttachments": { "get": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Get a collection of Regular Asset Task File Attachment resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTaskFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTaskFileAttachment->Version | integer | int32 |\r\n| regularAssetTaskId | RegularAssetTaskFileAttachment->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskFileAttachment->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFileAttachment->RegularAssetTask_Description | string | |\r\n| fileFullName | RegularAssetTaskFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | RegularAssetTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | RegularAssetTaskFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetTaskFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | RegularAssetTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTaskFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | RegularAssetTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | RegularAssetTaskFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskFileAttachmentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FileAttachments/Upload": { "post": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Upload and create a new Regular Asset Task File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTaskId | RegularAssetTaskFileAttachment->RegularAssetTask_Id | integer | int64 |\r\n| isRestricted | RegularAssetTaskFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetTaskFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RegularAssetTaskFileAttachment->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | 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": "CreateRegularAssetTaskFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRegularAssetTaskFileAttachmentResourceActionRequest" } } ], "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/RegularAssetTasks/FileAttachments/{id}/Upload": { "put": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Upload new content for an existing Regular Asset Task File Attachment resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RegularAssetTaskFileAttachment->Version | integer | int32 |\r\n| bytes | RegularAssetTaskFileAttachment->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": "UpdateRegularAssetTaskFileAttachmentContent", "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/UpdateRegularAssetTaskFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Get a collection of Regular Asset Task File Attachment resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTaskId | RegularAssetTaskFileAttachment->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskFileAttachment->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFileAttachment->RegularAssetTask_Description | string | |\r\n| createdByUserId | RegularAssetTaskFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskFileAttachment->CreatedOn | string | date-time |\r\n| contentId | RegularAssetTaskFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | RegularAssetTaskFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | RegularAssetTaskFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | RegularAssetTaskFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | RegularAssetTaskFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | RegularAssetTaskFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | RegularAssetTaskFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | RegularAssetTaskFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | RegularAssetTaskFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | RegularAssetTaskFileAttachment->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 | RegularAssetTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | RegularAssetTaskFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | RegularAssetTaskFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | RegularAssetTaskFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | RegularAssetTaskFileAttachment->FileFullName | string | |\r\n| fileName | RegularAssetTaskFileAttachment->FileName | string | |\r\n| fileTypeId | RegularAssetTaskFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | RegularAssetTaskFileAttachment->FileType_Extension | string | |\r\n| isRestricted | RegularAssetTaskFileAttachment->IsRestricted | boolean | |\r\n| id | RegularAssetTaskFileAttachment->Id | integer | int64 |\r\n| isActive | RegularAssetTaskFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | RegularAssetTaskFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | RegularAssetTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFileAttachment->PermissionTree_Description | string | |\r\n| version | RegularAssetTaskFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetRegularAssetTaskFileAttachment", "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 Task File Attachment id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Regular Asset Task File Attachment.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | FileAttachmentContentHistory->Id | integer | int64 |\r\n| version | FileAttachmentContentHistory->Version | integer | int32 |\r\n| contentId | FileAttachmentContentHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | FileAttachmentContentHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | FileAttachmentContentHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | FileAttachmentContentHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | FileAttachmentContentHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | FileAttachmentContentHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | FileAttachmentContentHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | FileAttachmentContentHistory->ContentVersion | integer | int32 |\r\n| createdOn | FileAttachmentContentHistory->CreatedOn | string | date-time |\r\n| fileAttachmentId | FileAttachmentContentHistory->FileAttachment_Id | integer | int64 |\r\n", "operationId": "GetRegularAssetTaskFileAttachmentContentHistory", "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 Task File Attachment collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FileAttachments/Upload/Batch": { "post": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Upload and create a new collection of Regular Asset Task File Attachment resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| regularAssetTaskId | RegularAssetTaskFileAttachment->RegularAssetTask_Id | integer | int64 |\r\n| isRestricted | RegularAssetTaskFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetTaskFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetTaskFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | RegularAssetTaskFileAttachment->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | 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": "BatchCreateRegularAssetTaskFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRegularAssetTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset Task File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FileAttachments/Batch": { "patch": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Update a collection of existing Regular Asset Task File Attachment resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTaskFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTaskFileAttachment->Version | integer | int32 |\r\n| isRestricted | RegularAssetTaskFileAttachment->IsRestricted | boolean | |\r\n| fileName | RegularAssetTaskFileAttachment->FileName | string | |\r\n| fileCategoryId | RegularAssetTaskFileAttachment->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": "BatchUpdateRegularAssetTaskFileAttachment", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task File Attachment batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task File Attachment" ], "summary": "Delete a collection of existing Regular Asset Task File Attachment resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTaskFileAttachment->Id | integer | int64 |\r\n| version | RegularAssetTaskFileAttachment->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": "BatchDeleteRegularAssetTaskFileAttachment", "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/BatchDeleteRegularAssetTaskFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task File Attachment batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/{id}": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskFollowUpTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskFollowUpTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskFollowUpTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskFollowUpTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskFollowUpTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskFollowUpTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskFollowUpTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskFollowUpTask->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskFollowUpTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskFollowUpTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskFollowUpTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskFollowUpTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskFollowUpTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskFollowUpTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskFollowUpTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskFollowUpTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFollowUpTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFollowUpTask->PermissionTree_Description | string | |\r\n| addToWorkOrder | RegularAssetTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskFollowUpTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskFollowUpTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskFollowUpTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFollowUpTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskMonitoringPointTypeId | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_Id | integer | int64 |\r\n| regularAssetTaskMonitoringPointTypeHasUpperCriticalBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| regularAssetTaskMonitoringPointTypeHasUpperWarningBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| regularAssetTaskMonitoringPointTypeHasLowerCriticalBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| regularAssetTaskMonitoringPointTypeHasLowerWarningBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasLowerWarningBound | boolean | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n", "operationId": "GetRegularAssetTaskFollowUpTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Task Follow Up Task", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| triggerWhenLowerCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| addToWorkOrder | RegularAssetTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetTaskFollowUpTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskFollowUpTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskFollowUpTask->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": "DeleteRegularAssetTaskFollowUpTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskFollowUpTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Follow Up Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskFollowUpTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| regularAssetTaskId | RegularAssetTaskFollowUpTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskFollowUpTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFollowUpTask->RegularAssetTask_Description | string | |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskFollowUpTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| lastConfirmedOn | RegularAssetTaskFollowUpTask->LastConfirmedOn | string | date-time |\r\n| unsynchronised | RegularAssetTaskFollowUpTask->Unsynchronised | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskFollowUpTask->LastConfirmedChangeLogId | integer | int64 |\r\n| developmentStatus | RegularAssetTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| addToWorkOrder | RegularAssetTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n", "operationId": "GetRegularAssetTaskFollowUpTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Follow Up Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskFollowUpTask->RegularAssetTask_Id | integer | int64 |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| addToWorkOrder | RegularAssetTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | 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 | Required | True | |\r\n| addToWorkOrder | Nullable | False | |\r\n\r\n", "operationId": "CreateRegularAssetTaskFollowUpTask", "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/CreateRegularAssetTaskFollowUpTaskResourceActionRequest" } }, { "$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/RegularAssetTasks/{regularAssetTaskId}/FollowUpTasks": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Get a collection of Regular Asset Task Follow Up Task resources for the Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n| isInherited | RegularAssetTaskFollowUpTask->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| developmentStatus | RegularAssetTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| createdOn | RegularAssetTaskFollowUpTask->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskFollowUpTask->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskFollowUpTaskForRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTaskId", "in": "path", "required": true, "description": "Regular Asset 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 Task Follow Up Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Lookups/LookupRegularAssetTaskFollowUpTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskFollowUpTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Lookups/LookupRegularAssetTaskFollowUpTaskFollowUpTask": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Lookup the Regular Asset Task Follow Up Task for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskFollowUpTaskFollowUpTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskFollowUpTaskFollowUpTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Lookups/LookupRegularAssetTaskFollowUpTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskFollowUpTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Lookups/LookupRegularAssetTaskFollowUpTaskRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Lookup the Regular Asset Task Follow Up Task for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n| monitoringPointTypeId | RegularAssetTask->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeHasUpperCriticalBound | RegularAssetTask->MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| monitoringPointTypeHasUpperWarningBound | RegularAssetTask->MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| monitoringPointTypeHasLowerCriticalBound | RegularAssetTask->MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| monitoringPointTypeHasLowerWarningBound | RegularAssetTask->MonitoringPointType_HasLowerWarningBound | boolean | |\r\n", "operationId": "LookupRegularAssetTaskFollowUpTaskRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskFollowUpTaskRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetTaskFollowUpTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskFollowUpTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskFollowUpTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskFollowUpTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskFollowUpTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskFollowUpTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskFollowUpTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskFollowUpTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskFollowUpTask->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskFollowUpTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskFollowUpTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskFollowUpTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskFollowUpTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskFollowUpTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskFollowUpTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskFollowUpTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskFollowUpTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFollowUpTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFollowUpTask->PermissionTree_Description | string | |\r\n| addToWorkOrder | RegularAssetTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskFollowUpTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskFollowUpTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskFollowUpTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFollowUpTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskMonitoringPointTypeId | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_Id | integer | int64 |\r\n| regularAssetTaskMonitoringPointTypeHasUpperCriticalBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| regularAssetTaskMonitoringPointTypeHasUpperWarningBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| regularAssetTaskMonitoringPointTypeHasLowerCriticalBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| regularAssetTaskMonitoringPointTypeHasLowerWarningBound | RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasLowerWarningBound | boolean | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n", "operationId": "BatchGetRegularAssetTaskFollowUpTask", "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 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 Task Follow Up Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskFollowUpTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Batch": { "post": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Create a new collection of Regular Asset 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| permissionTreeId | RegularAssetTaskFollowUpTask->PermissionTree_Id | integer | int64 |\r\n| regularAssetTaskId | RegularAssetTaskFollowUpTask->RegularAssetTask_Id | integer | int64 |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| addToWorkOrder | RegularAssetTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | > 0| |\r\n| followUpTaskId | Required | True | |\r\n| followUpTaskId | Nullable | False | |\r\n| followUpTaskId | Min Value | > 0| |\r\n| addToWorkOrder | Required | True | |\r\n| addToWorkOrder | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTaskFollowUpTask", "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/BatchCreateRegularAssetTaskFollowUpTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Follow Up Task" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| followUpTaskId | RegularAssetTaskFollowUpTask->FollowUpTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskFollowUpTask->SequenceNumber | integer | int32 |\r\n| addToWorkOrder | RegularAssetTaskFollowUpTask->AddToWorkOrder | boolean | |\r\n| triggerWhenLowerCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound | boolean | |\r\n| triggerWhenLowerWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound | boolean | |\r\n| triggerWhenUpperCriticalBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound | boolean | |\r\n| triggerWhenUpperWarningBound | RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound | boolean | |\r\n| notes | RegularAssetTaskFollowUpTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateRegularAssetTaskFollowUpTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskFollowUpTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetTaskFollowUpTask", "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/BatchDeleteRegularAssetTaskFollowUpTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Follow Up Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Accept the Development Status for an existing Regular Asset Task Follow Up Task resource.", "description": "", "operationId": "AcceptRegularAssetTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Follow Up Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Follow Up Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Follow Up Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Follow Up Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskFollowUpTask->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": "ChangeRegularAssetTaskFollowUpTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/FollowUpTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTask->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": "ChangeRegularAssetTaskFollowUpTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/FollowUpTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Reject the Development Status for an existing Regular Asset Task Follow Up Task resource.", "description": "", "operationId": "RejectRegularAssetTaskFollowUpTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskFollowUpTask->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": "BatchChangeRegularAssetTaskFollowUpTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskFollowUpTaskIsActiveResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/FollowUpTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Follow Up Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTask->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": "BatchChangeRegularAssetTaskFollowUpTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskFollowUpTaskPermissionTreeResourceActionRequest" } }, { "type": "boolean", "name": "includeChildren", "in": "query", "description": "Include children when executing the change 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/RegularAssetTasks/FollowUpTask/Expressions/{id}": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Get a Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| isActive | RegularAssetTaskFollowUpTaskExpression->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskFollowUpTaskExpression->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskFollowUpTaskExpression->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskFollowUpTaskExpression->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskFollowUpTaskExpression->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskFollowUpTaskExpression->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskFollowUpTaskExpression->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskFollowUpTaskExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskFollowUpTaskExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskFollowUpTaskExpression->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskFollowUpTaskExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskFollowUpTaskExpression->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTaskExpression->InheritedFrom_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| monitoringPointTriggerExpressionId | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n| regularAssetTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskDescription | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Description | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Code | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskDescription | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Description | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskInspectionType | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n", "operationId": "GetRegularAssetTaskFollowUpTaskExpression", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Task Follow Up Task Expression", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskExpressionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "UpdateRegularAssetTaskFollowUpTaskExpression", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->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": "DeleteRegularAssetTaskFollowUpTaskExpression", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Follow Up Task Expression 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/RegularAssetTasks/FollowUpTask/Expressions": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n| isInherited | RegularAssetTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTaskExpression->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskFollowUpTaskFollowUpTaskCode | RegularAssetTaskFollowUpTaskExpression->InheritedFrom_RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| regularAssetTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Code | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskAssetId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskInspectionType | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n| monitoringPointTriggerExpressionId | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| developmentStatus | RegularAssetTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| createdOn | RegularAssetTaskFollowUpTaskExpression->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskFollowUpTaskExpression->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskFollowUpTaskExpressionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Follow Up Task Expression collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskExpressionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Create a new Regular Asset 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| permissionTreeId | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionId | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| regularAssetTaskFollowUpTaskId | Required | True | |\r\n| regularAssetTaskFollowUpTaskId | Nullable | False | |\r\n| regularAssetTaskFollowUpTaskId | Min Value | > 0| |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| monitoringPointTriggerExpressionId | Min Value | > 0| |\r\n\r\n", "operationId": "CreateRegularAssetTaskFollowUpTaskExpression", "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/CreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, { "$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/RegularAssetTasks/FollowUpTasks/{regularAssetTaskFollowUpTaskId}/Expressions": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Get a collection of Regular Asset Task Follow Up Task Expression resources for the Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n| isInherited | RegularAssetTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTaskExpression->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromRegularAssetTypeTaskFollowUpTaskFollowUpTaskCode | RegularAssetTaskFollowUpTaskExpression->InheritedFrom_RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| regularAssetTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Code | string | |\r\n| monitoringPointTriggerExpressionId | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| developmentStatus | RegularAssetTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| createdOn | RegularAssetTaskFollowUpTaskExpression->CreatedOn | string | date-time |\r\n| modifiedOn | RegularAssetTaskFollowUpTaskExpression->ModifiedOn | string | date-time |\r\n", "operationId": "GetRegularAssetTaskFollowUpTaskExpressionForRegularAssetTaskFollowUpTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTaskFollowUpTaskId", "in": "path", "required": true, "description": "Regular Asset 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 Task Follow Up Task Expression collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskExpressionForRegularAssetTaskFollowUpTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Lookups/LookupRegularAssetTaskFollowUpTaskExpressionChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskFollowUpTaskExpressionChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Lookups/LookupRegularAssetTaskFollowUpTaskExpressionInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskFollowUpTaskExpressionInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Lookups/LookupRegularAssetTaskFollowUpTaskExpressionMonitoringPointTriggerExpression": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Lookup the Regular Asset Task Follow Up Task Expression for the Regular Asset 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| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskFollowUpTaskExpressionMonitoringPointTriggerExpression", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskFollowUpTaskExpressionMonitoringPointTriggerExpressionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Lookups/LookupRegularAssetTaskFollowUpTaskExpressionRegularAssetTaskFollowUpTask": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Lookup the Regular Asset Task Follow Up Task Expression for the Regular Asset 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 | RegularAssetTaskFollowUpTask->Id | integer | int64 |\r\n| followUpTaskCode | RegularAssetTaskFollowUpTask->FollowUpTask_Code | string | |\r\n| followUpTaskDescription | RegularAssetTaskFollowUpTask->FollowUpTask_Description | string | |\r\n| regularAssetTaskCode | RegularAssetTaskFollowUpTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskFollowUpTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskInspectionType | RegularAssetTaskFollowUpTask->RegularAssetTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n", "operationId": "LookupRegularAssetTaskFollowUpTaskExpressionRegularAssetTaskFollowUpTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Follow Up Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskFollowUpTaskExpressionRegularAssetTaskFollowUpTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| isActive | RegularAssetTaskFollowUpTaskExpression->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskFollowUpTaskExpression->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskFollowUpTaskExpression->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskFollowUpTaskExpression->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskFollowUpTaskExpression->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskFollowUpTaskExpression->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskFollowUpTaskExpression->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskFollowUpTaskExpression->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskFollowUpTaskExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskFollowUpTaskExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskFollowUpTaskExpression->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskFollowUpTaskExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskFollowUpTaskExpression->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Description | string | |\r\n| inheritedFromId | RegularAssetTaskFollowUpTaskExpression->InheritedFrom_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| monitoringPointTriggerExpressionId | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n| regularAssetTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Code | string | |\r\n| regularAssetTaskFollowUpTaskFollowUpTaskDescription | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Description | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskCode | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Code | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskDescription | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Description | string | |\r\n| regularAssetTaskFollowUpTaskRegularAssetTaskInspectionType | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_InspectionType | string (Allowed values: [PassOrFail, ManualMonitoring, AutomaticMonitoring, ManualAndAutomaticMonitoring, ManualReadingOnly]) | enum |\r\n", "operationId": "BatchGetRegularAssetTaskFollowUpTaskExpression", "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 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 Task Follow Up Task Expression collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskFollowUpTaskExpressionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Batch": { "post": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Create a new collection of Regular Asset 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| permissionTreeId | RegularAssetTaskFollowUpTaskExpression->PermissionTree_Id | integer | int64 |\r\n| regularAssetTaskFollowUpTaskId | RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionId | RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| regularAssetTaskFollowUpTaskId | Required | True | |\r\n| regularAssetTaskFollowUpTaskId | Nullable | False | |\r\n| regularAssetTaskFollowUpTaskId | Min Value | > 0| |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| monitoringPointTriggerExpressionId | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateRegularAssetTaskFollowUpTaskExpression", "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/BatchCreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Follow Up Task Expression" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskFollowUpTaskExpression->SequenceNumber | integer | int32 |\r\n| manualReadingRequired | RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired | boolean | |\r\n| notes | RegularAssetTaskFollowUpTaskExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "BatchUpdateRegularAssetTaskFollowUpTaskExpression", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTaskExpression->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetTaskFollowUpTaskExpression", "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/BatchDeleteRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Follow Up Task Expression 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/RegularAssetTasks/FollowUpTask/Expressions/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Accept the Development Status for an existing Regular Asset Task Follow Up Task Expression resource.", "description": "", "operationId": "AcceptRegularAssetTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Follow Up Task Expression resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Follow Up Task Expression id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Follow Up Task Expression resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Follow Up Task Expression id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| isActive | RegularAssetTaskFollowUpTaskExpression->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": "ChangeRegularAssetTaskFollowUpTaskExpressionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskExpressionIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTaskExpression->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": "ChangeRegularAssetTaskFollowUpTaskExpressionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Reject the Development Status for an existing Regular Asset Task Follow Up Task Expression resource.", "description": "", "operationId": "RejectRegularAssetTaskFollowUpTaskExpressionDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Follow Up Task Expression Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/FollowUpTask/Expressions/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| isActive | RegularAssetTaskFollowUpTaskExpression->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": "BatchChangeRegularAssetTaskFollowUpTaskExpressionIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskFollowUpTaskExpressionIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/FollowUpTask/Expressions/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Follow Up Task Expression" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskFollowUpTaskExpression->Id | integer | int64 |\r\n| version | RegularAssetTaskFollowUpTaskExpression->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskFollowUpTaskExpression->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": "BatchChangeRegularAssetTaskFollowUpTaskExpressionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/Resources/{id}": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetTaskResource->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskResource->Id | integer | int64 |\r\n| isActive | RegularAssetTaskResource->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskResource->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskResource->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskResource->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskResource->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskResource->LastConfirmedOn | string | date-time |\r\n| ruleEvaluationFailedReason | RegularAssetTaskResource->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetTaskResource->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTaskResource->RulesLastEvaluatedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskResource->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskResource->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskResource->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskResource->PermissionTree_Description | string | |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTaskResource->Competency_Description | string | |\r\n| competencyValidityType | RegularAssetTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | RegularAssetTaskResource->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| recordType | RegularAssetTaskResource->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskResource->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskResource->RegularAssetTask_Description | string | |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailId | RegularAssetTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | RegularAssetTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | RegularAssetTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n", "operationId": "GetRegularAssetTaskResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Resource", "schema": { "$ref": "#/definitions/GetRegularAssetTaskResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Resource" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskResource->Version | integer | int32 |\r\n| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | RegularAssetTaskResource->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| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | >= 0| |\r\n| tradeId | 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": "UpdateRegularAssetTaskResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Resource was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task Resource" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskResource->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": "DeleteRegularAssetTaskResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Resource was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| isActive | RegularAssetTaskResource->IsActive | boolean | |\r\n| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskResource->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskResource->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetTreePathItems | RegularAssetTaskResource->RegularAssetTask_Asset_TreePathItems | array | array |\r\n| regularAssetTaskComponentTreePathItems | RegularAssetTaskResource->RegularAssetTask_Component_TreePathItems | array | array |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTaskResource->Trade_Description | string | |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | RegularAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTaskResource->Competency_Description | string | |\r\n| inheritedFromId | RegularAssetTaskResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromResourceContactDetailFirstName | RegularAssetTaskResource->InheritedFrom_Resource_ContactDetailFirstName | string | |\r\n| inheritedFromResourceContactDetailLastName | RegularAssetTaskResource->InheritedFrom_Resource_ContactDetailLastName | string | |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n| rulesLastEvaluatedOn | RegularAssetTaskResource->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | RegularAssetTaskResource->RuleEvaluationPassed | boolean | |\r\n", "operationId": "GetRegularAssetTaskResourceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Resource collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Resource" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n| permissionTreeId | RegularAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | RegularAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetTaskResource->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | 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| 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": "CreateRegularAssetTaskResource", "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/CreateRegularAssetTaskResourceResourceActionRequest" } }, { "$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/RegularAssetTasks/{regularAssetTaskId}/Resources": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Get a collection of Regular Asset Task Resource resources for the Regular Asset 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 | RegularAssetTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| isActive | RegularAssetTaskResource->IsActive | boolean | |\r\n| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskResource->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskResource->RegularAssetTask_Description | string | |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTaskResource->Trade_Description | string | |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailFirstName | RegularAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTaskResource->Competency_Description | string | |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n", "operationId": "GetRegularAssetTaskResourceForRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTaskId", "in": "path", "required": true, "description": "Regular Asset 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 Task Resource collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskResourceForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceFilterByTrade": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Trade for the Regular Asset 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": "LookupRegularAssetTaskResourceFilterByTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceFilterByTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceFilterByTradeUnitOfMeasurement": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the for the Regular Asset 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": "LookupRegularAssetTaskResourceFilterByTradeUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskResourceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceCompetency": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Competency for the Regular Asset 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": "LookupRegularAssetTaskResourceCompetency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceCompetencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskResourceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Regular Asset Task Resource for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskResourceRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskResourceRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceResource": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Resource for the Regular Asset 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": "LookupRegularAssetTaskResourceResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceSection": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Section for the Regular Asset 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": "LookupRegularAssetTaskResourceSection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceSectionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceSystemAssignResource": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Resource for the Regular Asset 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": "LookupRegularAssetTaskResourceSystemAssignResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceSystemAssignResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceTradeFilter": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Trade for the Regular Asset 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": "LookupRegularAssetTaskResourceTradeFilter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceTradeFilterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the for the Regular Asset 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": "LookupRegularAssetTaskResourceTradeFinancialRateUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Unit Of Measurement collection", "schema": { "$ref": "#/definitions/RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceTrade": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the Trade for the Regular Asset 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": "LookupRegularAssetTaskResourceTrade", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceTradeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Lookups/LookupRegularAssetTaskResourceUnitOfMeasurement": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Lookup the for the Regular Asset 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": "LookupRegularAssetTaskResourceUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskResourceUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Resource" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetTaskResource->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskResource->Id | integer | int64 |\r\n| isActive | RegularAssetTaskResource->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskResource->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskResource->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskResource->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskResource->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskResource->LastConfirmedOn | string | date-time |\r\n| ruleEvaluationFailedReason | RegularAssetTaskResource->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetTaskResource->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTaskResource->RulesLastEvaluatedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskResource->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskResource->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskResource->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskResource->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskResource->PermissionTree_Description | string | |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| competencyCode | RegularAssetTaskResource->Competency_Code | string | |\r\n| competencyDescription | RegularAssetTaskResource->Competency_Description | string | |\r\n| competencyValidityType | RegularAssetTaskResource->Competency_ValidityType | string (Allowed values: [Permanent, Transient]) | enum |\r\n| inheritedFromId | RegularAssetTaskResource->InheritedFrom_Id | integer | int64 |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| recordType | RegularAssetTaskResource->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskResource->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskResource->RegularAssetTask_Description | string | |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceCode | RegularAssetTaskResource->Resource_Code | string | |\r\n| resourceContactDetailId | RegularAssetTaskResource->Resource_ContactDetailId | integer | int64 |\r\n| resourceContactDetailFirstName | RegularAssetTaskResource->Resource_ContactDetailFirstName | string | |\r\n| resourceContactDetailLastName | RegularAssetTaskResource->Resource_ContactDetailLastName | string | |\r\n| resourceType | RegularAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| sectionCode | RegularAssetTaskResource->Section_Code | string | |\r\n| sectionDescription | RegularAssetTaskResource->Section_Description | string | |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| tradeCode | RegularAssetTaskResource->Trade_Code | string | |\r\n| tradeDescription | RegularAssetTaskResource->Trade_Description | string | |\r\n| unitOfMeasurementId | RegularAssetTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | RegularAssetTaskResource->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | RegularAssetTaskResource->UnitOfMeasurement_Description | string | |\r\n| unitOfMeasurementMeasurementType | RegularAssetTaskResource->UnitOfMeasurement_MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n", "operationId": "BatchGetRegularAssetTaskResource", "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 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 Task Resource collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Batch": { "post": { "tags": [ "Regular Asset Task Resource" ], "summary": "Create a new collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n| permissionTreeId | RegularAssetTaskResource->PermissionTree_Id | integer | int64 |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | RegularAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetTaskResource->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | 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| 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": "BatchCreateRegularAssetTaskResource", "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/BatchCreateRegularAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Resource" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| regularAssetTaskId | RegularAssetTaskResource->RegularAssetTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskResource->Notes | string | |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| proficiency | RegularAssetTaskResource->Proficiency | integer | int32 |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| unitOfMeasurementId | RegularAssetTaskResource->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| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | >= 0| |\r\n| tradeId | 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": "BatchUpdateRegularAssetTaskResource", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Resource batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task Resource" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTaskResource->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": "BatchDeleteRegularAssetTaskResource", "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/BatchDeleteRegularAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Resource batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Resource" ], "summary": "Accept the Development Status for an existing Regular Asset Task Resource resource.", "description": "", "operationId": "AcceptRegularAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Resource" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Resource resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Resource" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Resource resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Resource id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Resource" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskResource->Version | integer | int32 |\r\n| isActive | RegularAssetTaskResource->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": "ChangeRegularAssetTaskResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskResourceIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Resource" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskResource->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": "ChangeRegularAssetTaskResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskResourcePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Resource" ], "summary": "Reject the Development Status for an existing Regular Asset Task Resource resource.", "description": "", "operationId": "RejectRegularAssetTaskResourceDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Resource Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Resources/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Resource" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| isActive | RegularAssetTaskResource->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": "BatchChangeRegularAssetTaskResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskResourceIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/Resources/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Resource" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskResource->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": "BatchChangeRegularAssetTaskResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskResourcePermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/Resources/MatchBatch": { "patch": { "tags": [ "Regular Asset Task Resource" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskResource->Id | integer | int64 |\r\n| version | RegularAssetTaskResource->Version | integer | int32 |\r\n| quantity | RegularAssetTaskResource->Quantity | integer | int32 |\r\n| resourceId | RegularAssetTaskResource->Resource_Id | integer | int64 |\r\n| resourceType | RegularAssetTaskResource->ResourceType | string (Allowed values: [StaffMember, SpecialResource, Contact]) | enum |\r\n| sectionId | RegularAssetTaskResource->Section_Id | integer | int64 |\r\n| tradeId | RegularAssetTaskResource->Trade_Id | integer | int64 |\r\n| competencyId | RegularAssetTaskResource->Competency_Id | integer | int64 |\r\n| unitOfMeasurementId | RegularAssetTaskResource->UnitOfMeasurement_Id | integer | int64 |\r\n| usage | RegularAssetTaskResource->Usage | object | composite |\r\n| sequenceNumber | RegularAssetTaskResource->SequenceNumber | integer | int32 |\r\n| proficiency | RegularAssetTaskResource->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\r\n", "operationId": "MatchUpdateRegularAssetTaskResource", "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/MatchUpdateRegularAssetTaskResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTasks/Spares/{id}": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetTaskSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskSpare->Id | integer | int64 |\r\n| isActive | RegularAssetTaskSpare->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskSpare->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskSpare->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskSpare->LastConfirmedOn | string | date-time |\r\n| ruleEvaluationFailedReason | RegularAssetTaskSpare->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetTaskSpare->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTaskSpare->RulesLastEvaluatedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskSpare->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskSpare->PermissionTree_Description | string | |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | RegularAssetTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromPreferredMaterialMasterId | RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id | integer | int64 |\r\n| inheritedFromPreferredMaterialMasterCode | RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code | string | |\r\n| inheritedFromPreferredMaterialMasterDescription | RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description | string | |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterDescription | RegularAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCode | RegularAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterCommodityId | RegularAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | RegularAssetTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| recordType | RegularAssetTaskSpare->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskSpare->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSpare->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSpare->RegularAssetTask_Description | string | |\r\n| stockItemId | RegularAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RegularAssetTaskSpare->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | RegularAssetTaskSpare->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | RegularAssetTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | RegularAssetTaskSpare->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | RegularAssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | RegularAssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n", "operationId": "GetRegularAssetTaskSpare", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Spare", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSpareResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Spare" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| stockItemId | RegularAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | RegularAssetTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | RegularAssetTaskSpare->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| materialMasterId | Nullable | False | |\r\n| stockItemId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateRegularAssetTaskSpare", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Spare was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task Spare" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskSpare->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": "DeleteRegularAssetTaskSpare", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Spare was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskSpare->IsInherited | boolean | |\r\n| inheritedFromId | RegularAssetTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| developmentStatus | RegularAssetTaskSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | RegularAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTaskSpare->CostElement_Description | string | |\r\n| regularAssetTaskId | RegularAssetTaskSpare->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSpare->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSpare->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetTreePathItems | RegularAssetTaskSpare->RegularAssetTask_Asset_TreePathItems | array | array |\r\n| regularAssetTaskComponentTreePathItems | RegularAssetTaskSpare->RegularAssetTask_Component_TreePathItems | array | array |\r\n| stockItemWarehouseCode | RegularAssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | RegularAssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| rulesLastEvaluatedOn | RegularAssetTaskSpare->RulesLastEvaluatedOn | string | date-time |\r\n| ruleEvaluationPassed | RegularAssetTaskSpare->RuleEvaluationPassed | boolean | |\r\n", "operationId": "GetRegularAssetTaskSpareCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Spare collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSpareCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Spare" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskSpare->RegularAssetTask_Id | integer | int64 |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| stockItemId | RegularAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | RegularAssetTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | RegularAssetTaskSpare->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | > 0| |\r\n| materialMasterId | System Generated | true | If no value specified |\r\n| materialMasterId | Nullable | False | |\r\n| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "CreateRegularAssetTaskSpare", "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/CreateRegularAssetTaskSpareResourceActionRequest" } }, { "$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/RegularAssetTasks/{regularAssetTaskId}/Spares": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Get a collection of Regular Asset Task Spare resources for the Regular Asset Task", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | RegularAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterDescription | RegularAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCommodityId | RegularAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTaskSpare->CostElement_Description | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| stockItemWarehouseCode | RegularAssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | RegularAssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n", "operationId": "GetRegularAssetTaskSpareForRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "regularAssetTaskId", "in": "path", "required": true, "description": "Regular Asset 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 Task Spare collection", "schema": { "$ref": "#/definitions/GetSpareForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskSpareChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSpareChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareCommodity": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the Commodity for the Regular Asset 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": "LookupRegularAssetTaskSpareCommodity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSpareCommodityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareCostElement": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the Cost Element for the Regular Asset 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": "LookupRegularAssetTaskSpareCostElement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSpareCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskSpareInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSpareInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareMaterialMasterForCommodity": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the Material Master for the Regular Asset 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": "LookupRegularAssetTaskSpareMaterialMasterForCommodity", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareMaterialMaster": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the Material Master for the Regular Asset 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| commodityDescription | MaterialMaster->Commodity_Description | string | |\r\n| commodityCode | MaterialMaster->Commodity_Code | string | |\r\n", "operationId": "LookupRegularAssetTaskSpareMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSpareMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the Regular Asset Task Spare for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskSpareRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskSpareTaskRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareStockItemForMaterialMaster": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the Stock Item for the Regular Asset Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterCommodityId | StockItem->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StockItem->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StockItem->MaterialMaster_Commodity_Description | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n", "operationId": "LookupRegularAssetTaskSpareStockItemForMaterialMaster", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Stock Item collection", "schema": { "$ref": "#/definitions/RegularAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Lookups/LookupRegularAssetTaskSpareStockItem": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Lookup the Stock Item for the Regular Asset Task Spare.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | StockItem->Id | integer | int64 |\r\n| materialMasterId | StockItem->MaterialMaster_Id | integer | int64 |\r\n| materialMasterCode | StockItem->MaterialMaster_Code | string | |\r\n| materialMasterCommodityId | StockItem->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | StockItem->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | StockItem->MaterialMaster_Commodity_Description | string | |\r\n| alternativeDescription | StockItem->AlternativeDescription | string | |\r\n| warehouseId | StockItem->Warehouse_Id | integer | int64 |\r\n| warehouseCode | StockItem->Warehouse_Code | string | |\r\n| warehouseDescription | StockItem->Warehouse_Description | string | |\r\n", "operationId": "LookupRegularAssetTaskSpareStockItem", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Stock Item collection", "schema": { "$ref": "#/definitions/RegularAssetTaskSpareStockItemLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Spare" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetTaskSpare->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskSpare->Id | integer | int64 |\r\n| isActive | RegularAssetTaskSpare->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskSpare->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskSpare->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskSpare->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskSpare->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskSpare->LastConfirmedOn | string | date-time |\r\n| ruleEvaluationFailedReason | RegularAssetTaskSpare->RuleEvaluationFailedReason | string (Allowed values: [Unknown, ParentFailed, RuleFailed, ChildrenFailed]) | enum |\r\n| ruleEvaluationPassed | RegularAssetTaskSpare->RuleEvaluationPassed | boolean | |\r\n| rulesLastEvaluatedOn | RegularAssetTaskSpare->RulesLastEvaluatedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskSpare->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskSpare->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskSpare->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskSpare->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskSpare->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskSpare->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskSpare->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskSpare->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskSpare->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskSpare->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskSpare->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskSpare->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskSpare->PermissionTree_Description | string | |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| costElementCode | RegularAssetTaskSpare->CostElement_Code | string | |\r\n| costElementDescription | RegularAssetTaskSpare->CostElement_Description | string | |\r\n| inheritedFromId | RegularAssetTaskSpare->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskSpare->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| inheritedFromPreferredMaterialMasterId | RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id | integer | int64 |\r\n| inheritedFromPreferredMaterialMasterCode | RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code | string | |\r\n| inheritedFromPreferredMaterialMasterDescription | RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description | string | |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| materialMasterDescription | RegularAssetTaskSpare->MaterialMaster_Description | string | |\r\n| materialMasterCode | RegularAssetTaskSpare->MaterialMaster_Code | string | |\r\n| materialMasterCommodityId | RegularAssetTaskSpare->MaterialMaster_Commodity_Id | integer | int64 |\r\n| materialMasterCommodityCode | RegularAssetTaskSpare->MaterialMaster_Commodity_Code | string | |\r\n| materialMasterCommodityDescription | RegularAssetTaskSpare->MaterialMaster_Commodity_Description | string | |\r\n| notes | RegularAssetTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| recordType | RegularAssetTaskSpare->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskSpare->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSpare->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSpare->RegularAssetTask_Description | string | |\r\n| stockItemId | RegularAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| stockItemAlternativeDescription | RegularAssetTaskSpare->StockItem_AlternativeDescription | string | |\r\n| stockItemMaterialMasterId | RegularAssetTaskSpare->StockItem_MaterialMaster_Id | integer | int64 |\r\n| stockItemMaterialMasterCode | RegularAssetTaskSpare->StockItem_MaterialMaster_Code | string | |\r\n| stockItemWarehouseId | RegularAssetTaskSpare->StockItem_Warehouse_Id | integer | int64 |\r\n| stockItemWarehouseCode | RegularAssetTaskSpare->StockItem_Warehouse_Code | string | |\r\n| stockItemWarehouseDescription | RegularAssetTaskSpare->StockItem_Warehouse_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTaskSpare", "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 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 Task Spare collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskSpareResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Batch": { "post": { "tags": [ "Regular Asset Task Spare" ], "summary": "Create a new collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskSpare->RegularAssetTask_Id | integer | int64 |\r\n| stockItemId | RegularAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| permissionTreeId | RegularAssetTaskSpare->PermissionTree_Id | integer | int64 |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| notes | RegularAssetTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | RegularAssetTaskSpare->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | > 0| |\r\n| stockItemId | Required | True | |\r\n| stockItemId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| costElementId | Required | True | |\r\n| costElementId | Nullable | False | |\r\n| materialMasterId | System Generated | true | If no value specified |\r\n| materialMasterId | Nullable | False | |\r\n| quantity | Required | True | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateRegularAssetTaskSpare", "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/BatchCreateRegularAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Spare" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| materialMasterId | RegularAssetTaskSpare->MaterialMaster_Id | integer | int64 |\r\n| stockItemId | RegularAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| costElementId | RegularAssetTaskSpare->CostElement_Id | integer | int64 |\r\n| notes | RegularAssetTaskSpare->Notes | string | |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| sequenceNumber | RegularAssetTaskSpare->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| materialMasterId | Nullable | False | |\r\n| stockItemId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n| quantity | Nullable | False | |\r\n| quantity | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTaskSpare", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Spare batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Regular Asset Task Spare" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetTaskSpare", "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/BatchDeleteRegularAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Spare batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Spare" ], "summary": "Accept the Development Status for an existing Regular Asset Task Spare resource.", "description": "", "operationId": "AcceptRegularAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Spare" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Spare resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Spare" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Spare resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Spare id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Spare" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskSpare->Version | integer | int32 |\r\n| isActive | RegularAssetTaskSpare->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": "ChangeRegularAssetTaskSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskSpareIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Spare" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSpare->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": "ChangeRegularAssetTaskSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskSparePermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Spare" ], "summary": "Reject the Development Status for an existing Regular Asset Task Spare resource.", "description": "", "operationId": "RejectRegularAssetTaskSpareDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Spare Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/Spares/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Spare" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| isActive | RegularAssetTaskSpare->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": "BatchChangeRegularAssetTaskSpareIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskSpareIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/Spares/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Spare" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSpare->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": "BatchChangeRegularAssetTaskSparePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskSparePermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/Spares/MatchBatch": { "patch": { "tags": [ "Regular Asset Task Spare" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskSpare->Id | integer | int64 |\r\n| version | RegularAssetTaskSpare->Version | integer | int32 |\r\n| quantity | RegularAssetTaskSpare->Quantity | number | decimal |\r\n| stockItemId | RegularAssetTaskSpare->StockItem_Id | integer | int64 |\r\n| costElementId | RegularAssetTaskSpare->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| stockItemId | Nullable | False | |\r\n| costElementId | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateRegularAssetTaskSpare", "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/MatchUpdateRegularAssetTaskSpareResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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/RegularAssetTasks/SubTasks/{id}": { "get": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskSubTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskSubTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskSubTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskSubTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskSubTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskSubTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskSubTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskSubTask->Unsynchronised | boolean | |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| createdByUserId | RegularAssetTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskSubTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskSubTask->PermissionTree_Description | string | |\r\n| alternativeDescription | RegularAssetTaskSubTask->AlternativeDescription | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| inheritedFromId | RegularAssetTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskSubTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | RegularAssetTaskSubTask->Notes | string | |\r\n| recordType | RegularAssetTaskSubTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskSubTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSubTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSubTask->RegularAssetTask_Description | string | |\r\n", "operationId": "GetRegularAssetTaskSubTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Sub Task", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSubTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskSubTask->Notes | string | |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTaskSubTask->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": "UpdateRegularAssetTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskSubTask->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": "DeleteRegularAssetTaskSubTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Sub Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks": { "get": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| regularAssetTaskId | RegularAssetTaskSubTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSubTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSubTask->RegularAssetTask_Description | string | |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| developmentStatus | RegularAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| alternativeDescription | RegularAssetTaskSubTask->AlternativeDescription | string | |\r\n| isInherited | RegularAssetTaskSubTask->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTaskSubTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Sub Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSubTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskSubTask->RegularAssetTask_Id | integer | int64 |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTaskSubTask->AlternativeDescription | string | |\r\n| notes | RegularAssetTaskSubTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskSubTask->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | 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": "CreateRegularAssetTaskSubTask", "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/CreateRegularAssetTaskSubTaskResourceActionRequest" } }, { "$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/RegularAssetTasks/{id}/SubTasks": { "get": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Get a collection of Regular Asset Task Sub Task resources for the Regular Asset 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 | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTaskSubTask->AlternativeDescription | string | |\r\n| developmentStatus | RegularAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTaskSubTask->IsInherited | boolean | |\r\n", "operationId": "GetRegularAssetTaskSubTaskForRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Task Sub Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSubTaskForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Lookups/LookupRegularAssetTaskSubTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskSubTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Lookups/LookupRegularAssetTaskSubTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskSubTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Lookups/LookupRegularAssetTaskSubTaskRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Lookup the Regular Asset Task Sub Task for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskSubTaskRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskSubTaskRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetTaskSubTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskSubTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskSubTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskSubTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskSubTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskSubTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskSubTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskSubTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskSubTask->Unsynchronised | boolean | |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| createdByUserId | RegularAssetTaskSubTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskSubTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskSubTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskSubTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskSubTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskSubTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskSubTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskSubTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskSubTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskSubTask->PermissionTree_Description | string | |\r\n| alternativeDescription | RegularAssetTaskSubTask->AlternativeDescription | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| inheritedFromId | RegularAssetTaskSubTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskSubTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | RegularAssetTaskSubTask->Notes | string | |\r\n| recordType | RegularAssetTaskSubTask->RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskId | RegularAssetTaskSubTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSubTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSubTask->RegularAssetTask_Description | string | |\r\n", "operationId": "BatchGetRegularAssetTaskSubTask", "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 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 Task Sub Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskSubTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Batch": { "post": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Create a new collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskSubTask->RegularAssetTask_Id | integer | int64 |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTaskSubTask->AlternativeDescription | string | |\r\n| notes | RegularAssetTaskSubTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTaskSubTask->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskSubTask->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | 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": "BatchCreateRegularAssetTaskSubTask", "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/BatchCreateRegularAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Sub Task" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskSubTask->SequenceNumber | integer | int32 |\r\n| notes | RegularAssetTaskSubTask->Notes | string | |\r\n| code | RegularAssetTaskSubTask->Code | string | |\r\n| description | RegularAssetTaskSubTask->Description | string | |\r\n| alternativeDescription | RegularAssetTaskSubTask->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": "BatchUpdateRegularAssetTaskSubTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSubTask->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": "BatchDeleteRegularAssetTaskSubTask", "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/BatchDeleteRegularAssetTaskSubTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Sub Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Accept the Development Status for an existing Regular Asset Task Sub Task resource.", "description": "", "operationId": "AcceptRegularAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Sub Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Sub Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Sub Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskSubTask->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": "ChangeRegularAssetTaskSubTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskSubTaskIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSubTask->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": "ChangeRegularAssetTaskSubTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskSubTaskPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Reject the Development Status for an existing Regular Asset Task Sub Task resource.", "description": "", "operationId": "RejectRegularAssetTaskSubTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Sub Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SubTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskSubTask->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": "BatchChangeRegularAssetTaskSubTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskSubTaskIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/SubTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Sub Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskSubTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSubTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSubTask->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": "BatchChangeRegularAssetTaskSubTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskSubTaskPermissionTreeResourceActionRequest" } }, { "$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/RegularAssetTasks/SuppressedTasks/{id}": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Get a Regular Asset 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| developmentStatus | RegularAssetTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskSuppressedTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskSuppressedTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskSuppressedTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskSuppressedTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskSuppressedTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskSuppressedTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskSuppressedTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskSuppressedTask->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskSuppressedTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskSuppressedTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskSuppressedTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskSuppressedTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskSuppressedTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskSuppressedTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskSuppressedTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskSuppressedTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskSuppressedTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskSuppressedTask->PermissionTree_Description | string | |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| inheritedFromId | RegularAssetTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskSuppressedTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | RegularAssetTaskSuppressedTask->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskSuppressedTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSuppressedTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSuppressedTask->RegularAssetTask_Description | string | |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| suppressedTaskIsActive | RegularAssetTaskSuppressedTask->SuppressedTask_IsActive | boolean | |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n", "operationId": "GetRegularAssetTaskSuppressedTask", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Regular Asset Task Suppressed Task", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSuppressedTaskResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Update an existing Regular Asset 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 | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| notes | RegularAssetTaskSuppressedTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | Nullable | False | |\r\n| suppressedTaskId | Min Value | > 0| |\r\n| suppressionPercentage | Nullable | False | RegularAssetTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTaskSuppressedTask->SuppressedDaysAfter gt 0 |\r\n| suppressedDaysAfter | Nullable | False | RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n| suppressedDaysBefore | Nullable | False | RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n\r\n", "operationId": "UpdateRegularAssetTaskSuppressedTask", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRegularAssetTaskSuppressedTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Delete an existing Regular Asset 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 | RegularAssetTaskSuppressedTask->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": "DeleteRegularAssetTaskSuppressedTask", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRegularAssetTaskSuppressedTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Suppressed Task was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Get a collection of Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| inheritedFromId | RegularAssetTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| isActive | RegularAssetTaskSuppressedTask->IsActive | boolean | |\r\n| regularAssetTaskId | RegularAssetTaskSuppressedTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSuppressedTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSuppressedTask->RegularAssetTask_Description | string | |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| lastConfirmedOn | RegularAssetTaskSuppressedTask->LastConfirmedOn | string | date-time |\r\n| developmentStatus | RegularAssetTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| isInherited | RegularAssetTaskSuppressedTask->IsInherited | boolean | |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| unsynchronised | RegularAssetTaskSuppressedTask->Unsynchronised | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskSuppressedTask->LastConfirmedChangeLogId | integer | int64 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskSuppressedTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| notes | RegularAssetTaskSuppressedTask->Notes | string | |\r\n", "operationId": "GetRegularAssetTaskSuppressedTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task Suppressed Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSuppressedTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Create a new Regular Asset 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| regularAssetTaskId | RegularAssetTaskSuppressedTask->RegularAssetTask_Id | integer | int64 |\r\n| notes | RegularAssetTaskSuppressedTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | Min Value | > 0| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| additionalNumberOfCyclesSuppressed | Required | True | |\r\n| additionalNumberOfCyclesSuppressed | Nullable | False | |\r\n| suppressionPercentage | Required | True | |\r\n| suppressionPercentage | Nullable | False | |\r\n| suppressedDaysAfter | Required | True | |\r\n| suppressedDaysAfter | Nullable | False | |\r\n| suppressedDaysBefore | Required | True | |\r\n| suppressedDaysBefore | Nullable | False | |\r\n| suppressedTaskId | Required | True | |\r\n| suppressedTaskId | Nullable | False | |\r\n| suppressedTaskId | Min Value | > 0| |\r\n\r\n", "operationId": "CreateRegularAssetTaskSuppressedTask", "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/CreateRegularAssetTaskSuppressedTaskResourceActionRequest" } }, { "$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/RegularAssetTasks/{id}/SuppressedTasks": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Get a collection of Regular Asset Task Suppressed Task resources for the Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| isInherited | RegularAssetTaskSuppressedTask->IsInherited | boolean | |\r\n| developmentStatus | RegularAssetTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n", "operationId": "GetRegularAssetTaskSuppressedTaskForRegularAssetTaskCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset 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 Task Suppressed Task collection", "schema": { "$ref": "#/definitions/GetRegularAssetTaskSuppressedTaskForRegularAssetTaskCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Lookups/LookupRegularAssetTaskSuppressedTaskChangePermissionTree": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Lookup the permission set for changing the Regular Asset 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": "LookupRegularAssetTaskSuppressedTaskChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Lookups/LookupRegularAssetTaskSuppressedTaskInsertPermissionTree": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Lookup the permission set for creating the Regular Asset 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": "LookupRegularAssetTaskSuppressedTaskInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/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/RegularAssetTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Lookups/LookupRegularAssetTaskSuppressedTaskRegularAssetTask": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Lookup the Regular Asset Task Suppressed Task for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskSuppressedTaskRegularAssetTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskSuppressedTaskRegularAssetTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Lookups/LookupRegularAssetTaskSuppressedTaskSuppressedTask": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Lookup the Regular Asset Task Suppressed Task for the Regular Asset 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 | RegularAssetTask->Id | integer | int64 |\r\n| code | RegularAssetTask->Code | string | |\r\n| description | RegularAssetTask->Description | string | |\r\n", "operationId": "LookupRegularAssetTaskSuppressedTaskSuppressedTask", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Regular Asset Task collection", "schema": { "$ref": "#/definitions/RegularAssetTaskSuppressedTaskSuppressedTaskLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Batch/{ids}": { "get": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Get a collection of Regular Asset 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| developmentStatus | RegularAssetTaskSuppressedTask->DevelopmentStatus | string (Allowed values: [NewAwaitingConfirmation, ModifiedAwaitingConfirmation, DeletedAwaitingConfirmation, DeletedConfirmed, Confirmed, NewUnderDevelopment, ModifiedUnderDevelopment]) | enum |\r\n| id | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| isActive | RegularAssetTaskSuppressedTask->IsActive | boolean | |\r\n| isHistorical | RegularAssetTaskSuppressedTask->IsHistorical | boolean | |\r\n| isInherited | RegularAssetTaskSuppressedTask->IsInherited | boolean | |\r\n| isProposed | RegularAssetTaskSuppressedTask->IsProposed | boolean | |\r\n| lastConfirmedChangeLogId | RegularAssetTaskSuppressedTask->LastConfirmedChangeLogId | integer | int64 |\r\n| lastConfirmedOn | RegularAssetTaskSuppressedTask->LastConfirmedOn | string | date-time |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| synchronisedWithTypeObjectUpTo | RegularAssetTaskSuppressedTask->SynchronisedWithTypeObjectUpTo | string | date-time |\r\n| unsynchronised | RegularAssetTaskSuppressedTask->Unsynchronised | boolean | |\r\n| createdByUserId | RegularAssetTaskSuppressedTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RegularAssetTaskSuppressedTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RegularAssetTaskSuppressedTask->CreatedByUser_FullName | string | |\r\n| createdOn | RegularAssetTaskSuppressedTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | RegularAssetTaskSuppressedTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RegularAssetTaskSuppressedTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RegularAssetTaskSuppressedTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RegularAssetTaskSuppressedTask->ModifiedOn | string | date-time |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RegularAssetTaskSuppressedTask->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RegularAssetTaskSuppressedTask->PermissionTree_Description | string | |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| inheritedFromId | RegularAssetTaskSuppressedTask->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromLastConfirmedOn | RegularAssetTaskSuppressedTask->InheritedFrom_LastConfirmedOn | string | date-time |\r\n| notes | RegularAssetTaskSuppressedTask->Notes | string | |\r\n| regularAssetTaskId | RegularAssetTaskSuppressedTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | RegularAssetTaskSuppressedTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | RegularAssetTaskSuppressedTask->RegularAssetTask_Description | string | |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressedTaskCode | RegularAssetTaskSuppressedTask->SuppressedTask_Code | string | |\r\n| suppressedTaskDescription | RegularAssetTaskSuppressedTask->SuppressedTask_Description | string | |\r\n| suppressedTaskIsActive | RegularAssetTaskSuppressedTask->SuppressedTask_IsActive | boolean | |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n", "operationId": "BatchGetRegularAssetTaskSuppressedTask", "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 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 Task Suppressed Task collection", "schema": { "$ref": "#/definitions/BatchGetRegularAssetTaskSuppressedTaskResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Batch": { "post": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Create a new collection of Regular Asset 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| regularAssetTaskId | RegularAssetTaskSuppressedTask->RegularAssetTask_Id | integer | int64 |\r\n| notes | RegularAssetTaskSuppressedTask->Notes | string | |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->PermissionTree_Id | integer | int64 |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->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| regularAssetTaskId | Required | True | |\r\n| regularAssetTaskId | Nullable | False | |\r\n| regularAssetTaskId | 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 | Required | True | |\r\n| additionalNumberOfCyclesSuppressed | Nullable | False | |\r\n| suppressionPercentage | Required | True | |\r\n| suppressionPercentage | Nullable | False | |\r\n| suppressedDaysAfter | Required | True | |\r\n| suppressedDaysAfter | Nullable | False | |\r\n| suppressedDaysBefore | Required | True | |\r\n| suppressedDaysBefore | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRegularAssetTaskSuppressedTask", "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/BatchCreateRegularAssetTaskSuppressedTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Regular Asset 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 Task Suppressed Task" ], "summary": "Update a collection of existing Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| sequenceNumber | RegularAssetTaskSuppressedTask->SequenceNumber | integer | int32 |\r\n| additionalNumberOfCyclesSuppressed | RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed | number | decimal |\r\n| suppressedTaskId | RegularAssetTaskSuppressedTask->SuppressedTask_Id | integer | int64 |\r\n| suppressionPercentage | RegularAssetTaskSuppressedTask->SuppressionPercentage | number | decimal |\r\n| suppressedDaysAfter | RegularAssetTaskSuppressedTask->SuppressedDaysAfter | integer | int32 |\r\n| suppressedDaysBefore | RegularAssetTaskSuppressedTask->SuppressedDaysBefore | integer | int32 |\r\n| notes | RegularAssetTaskSuppressedTask->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | Nullable | False | |\r\n| suppressedTaskId | Min Value | > 0| |\r\n| suppressionPercentage | Nullable | False | RegularAssetTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTaskSuppressedTask->SuppressedDaysAfter gt 0 |\r\n| suppressedDaysAfter | Nullable | False | RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n| suppressedDaysBefore | Nullable | False | RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0 |\r\n\r\n", "operationId": "BatchUpdateRegularAssetTaskSuppressedTask", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRegularAssetTaskSuppressedTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset 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" } } }, "delete": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Delete a collection of existing Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->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| id | Min Value | >= 0| |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRegularAssetTaskSuppressedTask", "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/BatchDeleteRegularAssetTaskSuppressedTaskResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Regular Asset Task Suppressed Task batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/{id}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Accept the Development Status for an existing Regular Asset Task Suppressed Task resource.", "description": "", "operationId": "AcceptRegularAssetTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Batch/{ids}/DevelopmentStatus/Accept": { "post": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Accept the Development Status for the collection of existing Regular Asset Task Suppressed Task resource id's.", "description": "", "operationId": "BatchAcceptRegularAssetTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Suppressed Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Batch/{ids}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Reject the Development Status for the collection of existing Regular Asset Task Suppressed Task resource id's.", "description": "", "operationId": "BatchRejectRegularAssetTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Regular Asset Task Suppressed Task id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/{id}/Active": { "patch": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Change the IsActive status for an existing Regular Asset 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 | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskSuppressedTask->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": "ChangeRegularAssetTaskSuppressedTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskSuppressedTaskIsActiveResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/{id}/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Change the PermissionTree for an existing Regular Asset 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 | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->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": "ChangeRegularAssetTaskSuppressedTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRegularAssetTaskSuppressedTaskPermissionTreeResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/{id}/DevelopmentStatus/Reject": { "post": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Reject the Development Status for an existing Regular Asset Task Suppressed Task resource.", "description": "", "operationId": "RejectRegularAssetTaskSuppressedTaskDevelopmentStatus", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Regular Asset Task Suppressed Task Id", "format": "int64", "x-nullable": false }, { "type": "string", "name": "message", "in": "query", "description": "Message to use for the development status background task", "x-nullable": true }, { "type": "integer", "name": "asyncStepFactor", "in": "query", "description": "If executed asynchronously, run the operation as a background task by grouping all records affected by the operation into background task steps. A value of zero (=0) will group all records into a single background task step. A value of one (=1) will create a background task step for every record. Any other value (=x) will create background task steps containing x records each.", "format": "int32", "x-nullable": true }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AMPC/RegularAssetTasks/SuppressedTasks/Batch/Active": { "patch": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Change the IsActive status for a collection of existing Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| isActive | RegularAssetTaskSuppressedTask->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": "BatchChangeRegularAssetTaskSuppressedTaskIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskSuppressedTaskIsActiveResourceActionRequest" } }, { "$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/RegularAssetTasks/SuppressedTasks/Batch/PermissionTree": { "patch": { "tags": [ "Regular Asset Task Suppressed Task" ], "summary": "Change the PermissionTree status for a collection of existing Regular Asset 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 | RegularAssetTaskSuppressedTask->Id | integer | int64 |\r\n| version | RegularAssetTaskSuppressedTask->Version | integer | int32 |\r\n| permissionTreeId | RegularAssetTaskSuppressedTask->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": "BatchChangeRegularAssetTaskSuppressedTaskPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRegularAssetTaskSuppressedTaskPermissionTreeResourceActionRequest" } }, { "$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" ] }, "GetAssetFmecaResourceActionResponse": { "title": "GetAssetFmecaResourceActionResponse", "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": "GetAssetFmecaResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFmeca->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmeca->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFmeca->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmeca->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmeca->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmeca->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetNearestRegularAssetId": { "title": "assetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_NearestRegularAsset_Id" }, "assetNearestRegularAssetCode": { "title": "assetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_NearestRegularAsset_Code" }, "assetNearestRegularAssetDescription": { "title": "assetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_NearestRegularAsset_Description" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "assetFunctionCode": { "title": "assetFunctionCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Code" }, "assetFunctionDescription": { "title": "assetFunctionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Description" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentAssetId": { "title": "componentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Asset_Id" }, "componentAssetCode": { "title": "componentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Asset_Code" }, "componentAssetDescription": { "title": "componentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Asset_Description" }, "componentAssetRecordType": { "title": "componentAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "componentAssetNearestRegularAssetId": { "title": "componentAssetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Asset_NearestRegularAsset_Id" }, "componentAssetNearestRegularAssetCode": { "title": "componentAssetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Asset_NearestRegularAsset_Code" }, "componentAssetNearestRegularAssetDescription": { "title": "componentAssetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Asset_NearestRegularAsset_Description" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Code" }, "failureCauseDescription": { "title": "failureCauseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Description" }, "failureCauseAdditionalInformation": { "title": "failureCauseAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCauseAdditionalInformation" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCauseType_Id", "x-NullExpression": "AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL" }, "failureCauseTypeCode": { "title": "failureCauseTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCauseType_Code" }, "failureCauseTypeDescription": { "title": "failureCauseTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCauseType_Description" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Code" }, "failureMechanismDescription": { "title": "failureMechanismDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Description" }, "failureMechanismAdditionalInformation": { "title": "failureMechanismAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanismAdditionalInformation" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanismType_Id", "x-NullExpression": "AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureCauseType_Id eq NULL" }, "failureMechanismTypeCode": { "title": "failureMechanismTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanismType_Code" }, "failureMechanismTypeDescription": { "title": "failureMechanismTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanismType_Description" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Code" }, "failureModeDescription": { "title": "failureModeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Description" }, "failureModeAdditionalInformation": { "title": "failureModeAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureModeAdditionalInformation" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureModeType_Id", "x-NullExpression": "AssetFmeca->FailureCauseType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL" }, "failureModeTypeCode": { "title": "failureModeTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureModeType_Code" }, "failureModeTypeDescription": { "title": "failureModeTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureModeType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmeca->InheritedFrom_LastConfirmedOn" }, "isFailureEvident": { "title": "isFailureEvident", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->IsFailureEvident" }, "isLegacy": { "title": "isLegacy", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->IsLegacy" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmeca->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Notes" }, "repairTypeId": { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairType_Id" }, "repairTypeCode": { "title": "repairTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairType_Code" }, "repairTypeDescription": { "title": "repairTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairType_Description" }, "repairTypeAdditionalInformation": { "title": "repairTypeAdditionalInformation", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairTypeAdditionalInformation" }, "warningEffects": { "title": "warningEffects", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } }, "GetAssetFmecaCollectionResourceActionResponse": { "title": "GetAssetFmecaCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetFmeca->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Code" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetFmeca->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "assetFunctionCode": { "title": "assetFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->AssetFunction_Code" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMode_Code" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanism_Code" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCause_Code" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmeca->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } } }, "GetAssetFmecaForInPlaceAssetCollectionResourceActionResponse": { "title": "GetAssetFmecaForInPlaceAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaForInPlaceAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaForInPlaceAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "assetFunctionCode": { "title": "assetFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->AssetFunction_Code" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMode_Code" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanism_Code" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } } }, "GetAssetFmecaForPlaceholderAssetCollectionResourceActionResponse": { "title": "GetAssetFmecaForPlaceholderAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaForPlaceholderAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaForPlaceholderAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "assetFunctionCode": { "title": "assetFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->AssetFunction_Code" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMode_Code" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanism_Code" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } } }, "GetAssetFmecaForPlaceholderAssetComponentCollectionResourceActionResponse": { "title": "GetAssetFmecaForPlaceholderAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaForPlaceholderAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaForPlaceholderAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "assetFunctionCode": { "title": "assetFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->AssetFunction_Code" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMode_Code" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanism_Code" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } } }, "GetAssetFmecaForRegularAssetCollectionResourceActionResponse": { "title": "GetAssetFmecaForRegularAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaForRegularAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaForRegularAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "assetFunctionCode": { "title": "assetFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->AssetFunction_Code" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMode_Code" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanism_Code" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } } }, "GetAssetFmecaForRegularAssetComponentCollectionResourceActionResponse": { "title": "GetAssetFmecaForRegularAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaForRegularAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaForRegularAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "assetFunctionCode": { "title": "assetFunctionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->AssetFunction_Code" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeCode": { "title": "failureModeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMode_Code" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismCode": { "title": "failureMechanismCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanism_Code" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseCode": { "title": "failureCauseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCause_Code" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFmeca->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFmeca->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } } }, "AssetFmecaAssetFunctionFromAssetComponentLookupResourceActionResponse": { "title": "AssetFmecaAssetFunctionFromAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaAssetFunctionFromAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaAssetFunctionFromAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetFmecaAssetFunctionFromAssetLookupResourceActionResponse": { "title": "AssetFmecaAssetFunctionFromAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaAssetFunctionFromAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaAssetFunctionFromAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetFmecaAssetLookupResourceActionResponse": { "title": "AssetFmecaAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetFmecaChangePermissionTreeLookupResourceActionResponse": { "title": "AssetFmecaChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaComponentLookupResourceActionResponse": { "title": "AssetFmecaComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponse": { "title": "AssetFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureCauseFromFailureCauseTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureCauseLookupResourceActionResponse": { "title": "AssetFmecaFailureCauseLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureCauseLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureCauseLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureCauseTypeLookupResourceActionResponse": { "title": "AssetFmecaFailureCauseTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureCauseTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureCauseTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureMechanismFromAssetFmecaFailureMechanismTypeLookupResourceActionResponse": { "title": "AssetFmecaFailureMechanismFromAssetFmecaFailureMechanismTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureMechanismFromAssetFmecaFailureMechanismTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureMechanismFromAssetFmecaFailureMechanismTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureMechanismLookupResourceActionResponse": { "title": "AssetFmecaFailureMechanismLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureMechanismLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureMechanismLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureMechanismTypeLookupResourceActionResponse": { "title": "AssetFmecaFailureMechanismTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureMechanismTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureMechanismTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureModeFromFailureModeTypeLookupResourceActionResponse": { "title": "AssetFmecaFailureModeFromFailureModeTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureModeFromFailureModeTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureModeFromFailureModeTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureModeLookupResourceActionResponse": { "title": "AssetFmecaFailureModeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureModeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureModeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaFailureModeTypeLookupResourceActionResponse": { "title": "AssetFmecaFailureModeTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaFailureModeTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaFailureModeTypeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetFmecaInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaRepairTypeLookupResourceActionResponse": { "title": "AssetFmecaRepairTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaRepairTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaRepairTypeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAssetFmecaResourceActionRequest": { "title": "CreateAssetFmecaResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAssetFmecaResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetId" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "AssetFmeca->Component_Id" }, "assetFunctionId": { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFmeca->SequenceNumber" }, "failureModeId": { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, "failureModeTypeId": { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureModeType_Id", "x-NullExpression": "AssetFmeca->FailureCauseType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL" }, "failureModeAdditionalInformation": { "title": "failureModeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureModeAdditionalInformation" }, "failureMechanismId": { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, "failureMechanismTypeId": { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanismType_Id", "x-NullExpression": "AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureCauseType_Id eq NULL" }, "failureMechanismAdditionalInformation": { "title": "failureMechanismAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanismAdditionalInformation" }, "failureCauseId": { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, "failureCauseTypeId": { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCauseType_Id", "x-NullExpression": "AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL" }, "failureCauseAdditionalInformation": { "title": "failureCauseAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCauseAdditionalInformation" }, "isFailureEvident": { "title": "isFailureEvident", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->IsFailureEvident" }, "warningEffects": { "title": "warningEffects", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->WarningEffects" }, "repairTypeId": { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairType_Id" }, "repairTypeAdditionalInformation": { "title": "repairTypeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairTypeAdditionalInformation" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->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" } } }, "UpdateAssetFmecaResourceActionRequest": { "title": "UpdateAssetFmecaResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "assetFunctionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->AssetFunction_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFmeca->SequenceNumber" }, { "title": "failureModeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMode_Id" }, { "title": "failureModeTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureModeType_Id", "x-NullExpression": "AssetFmeca->FailureCauseType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL" }, { "title": "failureModeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureModeAdditionalInformation" }, { "title": "failureMechanismId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanism_Id" }, { "title": "failureMechanismTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureMechanismType_Id", "x-NullExpression": "AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureCauseType_Id eq NULL" }, { "title": "failureMechanismAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureMechanismAdditionalInformation" }, { "title": "failureCauseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCause_Id" }, { "title": "failureCauseTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmeca->FailureCauseType_Id", "x-NullExpression": "AssetFmeca->FailureModeType_Id eq NULL AND AssetFmeca->FailureMechanismType_Id eq NULL" }, { "title": "failureCauseAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->FailureCauseAdditionalInformation" }, { "title": "isFailureEvident", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmeca->IsFailureEvident" }, { "title": "warningEffects", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->WarningEffects" }, { "title": "repairTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairType_Id" }, { "title": "repairTypeAdditionalInformation", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": true, "x-propertyPath": "AssetFmeca->RepairTypeAdditionalInformation" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Notes" } ] } } }, "DeleteDeleteAssetFmecaResourceActionResponse": { "title": "DeleteDeleteAssetFmecaResourceActionResponse", "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 } } }, "BatchGetAssetFmecaResourceAction": { "title": "BatchGetAssetFmecaResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset FMECA entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset FMECA entities", "items": { "$ref": "#/definitions/GetAssetFmecaResourceActionResponse" } }, "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" } } }, "BatchCreateAssetFmecaResourceActionRequest": { "title": "BatchCreateAssetFmecaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetFmecaResourceActionRequest" } }, "BatchUpdateAssetFmecaResourceActionRequest": { "title": "BatchUpdateAssetFmecaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetFmecaResourceActionRequest" } }, "BatchDeleteAssetFmecaResourceActionRequest": { "title": "BatchDeleteAssetFmecaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDeleteAssetFmecaResourceActionResponse" } }, "ChangeAssetFmecaIsActiveResourceActionRequest": { "title": "ChangeAssetFmecaIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AssetFmeca->IsActive" } ] } } }, "ChangeAssetFmecaPermissionTreeResourceActionRequest": { "title": "ChangeAssetFmecaPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AssetFmeca->PermissionTree_Id" } ] } } }, "BatchChangeAssetFmecaIsActiveResourceActionRequest": { "title": "BatchChangeAssetFmecaIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetFmecaIsActiveResourceActionRequest" } }, "BatchChangeAssetFmecaPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetFmecaPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetFmecaPermissionTreeResourceActionRequest" } }, "GetAssetFmecaTaskResourceActionResponse": { "title": "GetAssetFmecaTaskResourceActionResponse", "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": "GetAssetFmecaTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmecaTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmecaTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmecaTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFmecaTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->PermissionTree_Description" }, "assetFmecaId": { "title": "assetFmecaId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->AssetFmeca_Id" }, "assetFmecaAssetId": { "title": "assetFmecaAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->AssetFmeca_Asset_Id" }, "assetFmecaAssetCode": { "title": "assetFmecaAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->AssetFmeca_Asset_Code" }, "assetFmecaAssetDescription": { "title": "assetFmecaAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->AssetFmeca_Asset_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->Notes" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Description" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Asset_Id" }, "regularAssetTaskAssetCode": { "title": "regularAssetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Asset_Code" }, "regularAssetTaskAssetDescription": { "title": "regularAssetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Asset_Description" }, "regularAssetTaskComponentId": { "title": "regularAssetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Component_Id" }, "regularAssetTaskComponentCode": { "title": "regularAssetTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Component_Code" }, "regularAssetTaskComponentDescription": { "title": "regularAssetTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_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" } } }, "GetAssetFmecaTaskCollectionResourceActionResponse": { "title": "GetAssetFmecaTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetFmecaAssetCode": { "title": "assetFmecaAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->AssetFmeca_Asset_Code" }, "assetFmecaComponentCode": { "title": "assetFmecaComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->AssetFmeca_Component_Code" }, "assetFmecaLinkedToEntityType": { "title": "assetFmecaLinkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->AssetFmeca_LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Description" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Asset_Id" }, "regularAssetTaskAssetCode": { "title": "regularAssetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Asset_Code" }, "regularAssetTaskAssetDescription": { "title": "regularAssetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Asset_Description" }, "regularAssetTaskAssetTreePathItems": { "title": "regularAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskComponentCode": { "title": "regularAssetTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Component_Code" }, "regularAssetTaskComponentDescription": { "title": "regularAssetTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Component_Description" }, "regularAssetTaskComponentTreePathItems": { "title": "regularAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->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" } } } }, "GetAssetFmecaTaskForAssetFmecaCollectionResourceActionResponse": { "title": "GetAssetFmecaTaskForAssetFmecaCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFmecaTaskForAssetFmecaCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFmecaTaskForAssetFmecaCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->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" } } } }, "AssetFmecaTaskAssetFmecaLookupResourceActionResponse": { "title": "AssetFmecaTaskAssetFmecaLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaTaskAssetFmecaLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaTaskAssetFmecaLookupResourceActionResponseItemProperties", "type": "object", "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Asset_Description" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmeca->Component_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetFmecaTaskAssetTaskFromAssetComponentLookupResourceActionResponse": { "title": "AssetFmecaTaskAssetTaskFromAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaTaskAssetTaskFromAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaTaskAssetTaskFromAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->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" } } } }, "AssetFmecaTaskAssetTaskFromAssetLookupResourceActionResponse": { "title": "AssetFmecaTaskAssetTaskFromAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaTaskAssetTaskFromAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaTaskAssetTaskFromAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->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" } } } }, "AssetFmecaTaskChangePermissionTreeLookupResourceActionResponse": { "title": "AssetFmecaTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFmecaTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetFmecaTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFmecaTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFmecaTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAssetFmecaTaskResourceActionResponse": { "title": "CreateAssetFmecaTaskResourceActionResponse", "type": "object", "properties": { "properties": { "title": "CreateAssetFmecaTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "required": [ "assetFmecaId", "regularAssetTaskId" ], "properties": { "assetFmecaId": { "title": "assetFmecaId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->AssetFmeca_Id" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAssetFmecaTaskResourceActionResponse": { "title": "UpdateAssetFmecaTaskResourceActionResponse", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFmecaTask->RegularAssetTask_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFmecaTask->Notes" } ] } } }, "DeleteDeleteAssetFmecaTaskResourceActionResponse": { "title": "DeleteDeleteAssetFmecaTaskResourceActionResponse", "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 } } }, "BatchGetAssetFmecaTaskResourceAction": { "title": "BatchGetAssetFmecaTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset FMECA Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset FMECA Task entities", "items": { "$ref": "#/definitions/GetAssetFmecaTaskResourceActionResponse" } }, "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" } } }, "BatchCreateAssetFmecaTaskResourceActionRequest": { "title": "BatchCreateAssetFmecaTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetFmecaTaskResourceActionResponse" } }, "BatchUpdateAssetFmecaTaskResourceActionResponse": { "title": "BatchUpdateAssetFmecaTaskResourceActionResponse", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetFmecaTaskResourceActionResponse" } }, "BatchDeleteAssetFmecaTaskResourceActionRequest": { "title": "BatchDeleteAssetFmecaTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDeleteAssetFmecaTaskResourceActionResponse" } }, "ChangeAssetFmecaTaskIsActiveResourceActionRequest": { "title": "ChangeAssetFmecaTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AssetFmecaTask->IsActive" } ] } } }, "ChangeAssetFmecaTaskPermissionTreeResourceActionRequest": { "title": "ChangeAssetFmecaTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AssetFmecaTask->PermissionTree_Id" } ] } } }, "BatchChangeAssetFmecaTaskIsActiveResourceActionRequest": { "title": "BatchChangeAssetFmecaTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetFmecaTaskIsActiveResourceActionRequest" } }, "BatchChangeAssetFmecaTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetFmecaTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetFmecaTaskPermissionTreeResourceActionRequest" } }, "GetAssetFunctionResourceActionResponse": { "title": "GetAssetFunctionResourceActionResponse", "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": "GetAssetFunctionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFunction->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFunction->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFunction->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFunction->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFunction->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFunction->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFunction->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFunction->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetFunction->Unsynchronised" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFunction->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetFunction->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFunction->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFunction->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->Asset_Code" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFunction->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->Asset_Description" }, "assetComponentId": { "title": "assetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->AssetComponent_Id" }, "assetComponentCode": { "title": "assetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->AssetComponent_Code" }, "assetComponentDescription": { "title": "assetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->AssetComponent_Description" }, "assetComponentRecordType": { "title": "assetComponentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFunction->AssetComponent_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->InheritedFrom_Id" }, "linkedToEntityType": { "title": "linkedToEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFunction->LinkedToEntityType", "x-formatSpecifier": "EntityType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->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" } } }, "GetAssetFunctionForPlaceholderAssetComponentCollectionResourceActionResponse": { "title": "GetAssetFunctionForPlaceholderAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFunctionForPlaceholderAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFunctionForPlaceholderAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFunction->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFunction->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->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" } } } }, "GetAssetFunctionForRegularAssetComponentCollectionResourceActionResponse": { "title": "GetAssetFunctionForRegularAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFunctionForRegularAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFunctionForRegularAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFunction->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFunction->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->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" } } } }, "GetAssetFunctionCollectionResourceActionResponse": { "title": "GetAssetFunctionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFunctionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFunctionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->Asset_Code" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFunction->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetComponentCode": { "title": "assetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->AssetComponent_Code" }, "assetComponentRecordType": { "title": "assetComponentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetFunction->AssetComponent_RecordType", "x-formatSpecifier": "AssetComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetAssetFunctionForRegularAssetCollectionResourceActionResponse": { "title": "GetAssetFunctionForRegularAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFunctionForRegularAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFunctionForRegularAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFunction->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFunction->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->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" } } } }, "GetAssetFunctionForInPlaceAssetCollectionResourceActionResponse": { "title": "GetAssetFunctionForInPlaceAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFunctionForInPlaceAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFunctionForInPlaceAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFunction->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFunction->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->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" } } } }, "GetAssetFunctionForPlaceholderAssetCollectionResourceActionResponse": { "title": "GetAssetFunctionForPlaceholderAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetFunctionForPlaceholderAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetFunctionForPlaceholderAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetFunction->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetFunction->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->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" } } } }, "AssetFunctionAssetComponentLookupResourceActionResponse": { "title": "AssetFunctionAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFunctionAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFunctionAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetFunctionAssetLookupResourceActionResponse": { "title": "AssetFunctionAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFunctionAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFunctionAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetFunctionChangePermissionTreeLookupResourceActionResponse": { "title": "AssetFunctionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFunctionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFunctionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AssetFunctionInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetFunctionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetFunctionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetFunctionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAssetFunctionResourceActionResponse": { "title": "CreateAssetFunctionResourceActionResponse", "type": "object", "properties": { "properties": { "title": "CreateAssetFunctionResourceActionResponseProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "assetId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetFunction->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFunction->Asset_Id" }, "assetComponentId": { "title": "assetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetFunction->AssetComponent_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetFunction->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFunction->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAssetFunctionResourceActionResponse": { "title": "UpdateAssetFunctionResourceActionResponse", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AssetFunction->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetFunction->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetFunction->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetFunction->Notes" } ] } } }, "DeleteDeleteAssetFunctionResourceActionResponse": { "title": "DeleteDeleteAssetFunctionResourceActionResponse", "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 } } }, "BatchGetAssetFunctionResourceAction": { "title": "BatchGetAssetFunctionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Function entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Function entities", "items": { "$ref": "#/definitions/GetAssetFunctionResourceActionResponse" } }, "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" } } }, "BatchCreateAssetFunctionResourceActionRequest": { "title": "BatchCreateAssetFunctionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetFunctionResourceActionResponse" } }, "BatchUpdateAssetFunctionResourceActionResponse": { "title": "BatchUpdateAssetFunctionResourceActionResponse", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetFunctionResourceActionResponse" } }, "BatchDeleteAssetFunctionResourceActionRequest": { "title": "BatchDeleteAssetFunctionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDeleteAssetFunctionResourceActionResponse" } }, "ChangeAssetFunctionIsActiveResourceActionRequest": { "title": "ChangeAssetFunctionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AssetFunction->IsActive" } ] } } }, "ChangeAssetFunctionPermissionTreeResourceActionRequest": { "title": "ChangeAssetFunctionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AssetFunction->PermissionTree_Id" } ] } } }, "BatchChangeAssetFunctionIsActiveResourceActionRequest": { "title": "BatchChangeAssetFunctionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetFunctionIsActiveResourceActionRequest" } }, "BatchChangeAssetFunctionPermissionTreeResourceActionRequest": { "title": "BatchChangeAssetFunctionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetFunctionPermissionTreeResourceActionRequest" } }, "SetAssetTaskSpareWarehouseLookupResourceActionResponse": { "title": "SetAssetTaskSpareWarehouseLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "SetAssetTaskSpareWarehouseLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "SetAssetTaskSpareWarehouseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Warehouse->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetTaskSpareSetWarehouseResourceActionRequest": { "title": "AssetTaskSpareSetWarehouseResourceActionRequest", "type": "object", "properties": { "properties": { "title": "AssetTaskSpareSetWarehouseResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "warehouseId", "assetTaskSpareIds" ], "properties": { "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SetAssetTaskSpareWarehouseEntity->WarehouseId" }, "assetTaskSpareIds": { "title": "assetTaskSpareIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "SetAssetTaskSpareWarehouseEntity->AssetTaskSpareIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchAssetTaskSpareSetWarehouseResourceActionRequest": { "title": "BatchAssetTaskSpareSetWarehouseResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/AssetTaskSpareSetWarehouseResourceActionRequest" } }, "GetAssetTreePathMapResourceActionResponse": { "title": "GetAssetTreePathMapResourceActionResponse", "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" } } }, "GetAssetTreePathMapResourceAction": { "title": "GetAssetTreePathMapResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Tree entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Tree entities", "items": { "$ref": "#/definitions/GetAssetTreePathMapResourceActionResponse" } }, "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" } } }, "GetTreeWorkOrderRecursiveCollectionResourceActionResponse": { "title": "GetTreeWorkOrderRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeWorkOrderRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeWorkOrderRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->Asset_Description" }, "receivedOn": { "title": "receivedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->ReceivedOn" }, "requester": { "title": "requester", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Requester", "x-NullExpression": "WorkOrder->RequesterType eq 'FreeText'" }, "requiredBy": { "title": "requiredBy", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "WorkOrder->RequiredBy" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Site_Code" }, "staffMemberId": { "title": "staffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_Id" }, "staffMemberCode": { "title": "staffMemberCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->StaffMember_Code" }, "staffMemberContactDetailFullName": { "title": "staffMemberContactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_ContactDetailFullName" }, "staffMemberDefaultResourceTradeTradeId": { "title": "staffMemberDefaultResourceTradeTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->StaffMember_DefaultResourceTrade_Trade_Id" }, "staffMemberDefaultResourceTradeTradeCode": { "title": "staffMemberDefaultResourceTradeTradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->StaffMember_DefaultResourceTrade_Trade_Code" }, "staffMemberDefaultResourceTradeTradeDescription": { "title": "staffMemberDefaultResourceTradeTradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->StaffMember_DefaultResourceTrade_Trade_Description" }, "statusId": { "title": "statusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->Status_Id" }, "statusDescription": { "title": "statusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_Description" }, "statusBaseStatus": { "title": "statusBaseStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "WorkOrder->Status_BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_Id" }, "typeOfWorkWorkClass": { "title": "typeOfWorkWorkClass", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "WorkOrder->TypeOfWork_WorkClass", "x-formatSpecifier": "WorkClass" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->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" } } } }, "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" } } }, "GetTreeAssetComponentRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetComponentRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetComponentRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetComponentRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->PartNumber" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->RFId" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->QRCode" }, "specification": { "title": "specification", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Specification" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->SupplierPartNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetComponent->Quantity" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->SerialNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->Supplier_Description" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->ParentComponent_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->Site_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->AssetType_Description" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->PlaceholderForAssetType_Description" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->LinkedToAssetType_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetComponent->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetComponent->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetComponent->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" } } } }, "GetTreeAssetsRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetsRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetsRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetsRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Asset->SequenceNumber" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->SerialNumber" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Asset->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->PermissionTree_Description" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->AssetType_Code" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Code" }, "parentAssetCode": { "title": "parentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->ParentAsset_Code" }, "parentAssetDescription": { "title": "parentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->ParentAsset_Description" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": true, "x-propertyPath": "Asset->IsMsi" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "Asset->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Asset->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Asset->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" } } }, "GetTreeAssetTaskResourcesRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTaskResourcesRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTaskResourcesRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTaskResourcesRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTaskResource->IsActive" }, "assetTaskId": { "title": "assetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_Id" }, "assetTaskCode": { "title": "assetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_Code" }, "assetTaskDescription": { "title": "assetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_Description" }, "assetTaskRecordType": { "title": "assetTaskRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "assetTaskAssetId": { "title": "assetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_Asset_Id" }, "assetTaskAssetCode": { "title": "assetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_Asset_Code" }, "assetTaskAssetDescription": { "title": "assetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_Asset_Description" }, "assetTaskAssetTreePathItems": { "title": "assetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTaskResource->AssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetTaskComponentId": { "title": "assetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskResource->AssetTask_Component_Id" }, "assetTaskComponentTreePathItems": { "title": "assetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTaskResource->AssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Resource_ContactDetailLastName" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Trade_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->Competency_Description" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTaskResource->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTaskResource->RuleEvaluationPassed" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTaskResource->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskResource->Notes" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskResource->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" } } } }, "GetTreeAssetTaskSparesRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTaskSparesRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTaskSparesRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTaskSparesRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->CostElement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->Quantity" }, "assetTaskId": { "title": "assetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_Id" }, "assetTaskCode": { "title": "assetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_Code" }, "assetTaskDescription": { "title": "assetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_Description" }, "assetTaskRecordType": { "title": "assetTaskRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "assetTaskAssetId": { "title": "assetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_Asset_Id" }, "assetTaskAssetCode": { "title": "assetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_Asset_Code" }, "assetTaskAssetDescription": { "title": "assetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_Asset_Description" }, "assetTaskAssetTreePathItems": { "title": "assetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTaskSpare->AssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetTaskComponentId": { "title": "assetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->AssetTask_Component_Id" }, "assetTaskComponentTreePathItems": { "title": "assetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTaskSpare->AssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->StockItem_Warehouse_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTaskSpare->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->RuleEvaluationPassed" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTaskSpare->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" } } } }, "GetTreeAssetTasksRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTasksRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTasksRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTasksRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTask->Code" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTask->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTask->AlternativeDescription" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTask->IsInherited" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTask->IsInspection" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTask->IsNonUsageBasedReadingRequired" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTask->IsMandatory" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTask->DefaultInterval1_Code" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetTask->RulesLastEvaluatedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetTask->SequenceNumber" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTask->Asset_Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTask->PermissionTree_Description" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetTask->RuleEvaluationPassed" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetTask->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" } } } }, "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" } } } }, "GetTreeAuxiliaryAssetTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeAuxiliaryAssetTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAuxiliaryAssetTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAuxiliaryAssetTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AlternativeDescription" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->SequenceNumber" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->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" } } } }, "GetTreeRegularAssetTaskAuxiliaryTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTaskAuxiliaryTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTaskAuxiliaryTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTaskAuxiliaryTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_Id" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Description" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Asset_Id" }, "regularAssetTaskComponentId": { "title": "regularAssetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Component_Id" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->SequenceNumber" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->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" } } } }, "GetTreeAssetTaskConditionsRecursiveCollectionResourceActionResponse": { "title": "GetTreeAssetTaskConditionsRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeAssetTaskConditionsRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeAssetTaskConditionsRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Description" }, "regularAssetTaskIntervalType1Id": { "title": "regularAssetTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Asset_Id" }, "regularAssetTaskComponentId": { "title": "regularAssetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Component_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_Id" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Description" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_LastConfirmedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Unsynchronised" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->LastConfirmedOn" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Id" }, "intervalCode": { "title": "intervalCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Interval_Code" }, "intervalDescription": { "title": "intervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Description" }, "activeCondition": { "title": "activeCondition", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ActiveCondition" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetTreeRegularAssetTaskFollowUpTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTaskFollowUpTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTaskFollowUpTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTaskFollowUpTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->InheritedFrom_Id" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Description" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Asset_Id" }, "regularAssetTaskAssetTreePathItems": { "title": "regularAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskComponentId": { "title": "regularAssetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Component_Id" }, "regularAssetTaskComponentTreePathItems": { "title": "regularAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->SequenceNumber" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->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" } } } }, "GetTreeRegularAssetTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInspection" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_Id" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsDualScheduling" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SequenceNumber" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Code" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDuration" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDowntime" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->RulesLastEvaluatedOn" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Importance_Id" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Code" }, "importanceDescription": { "title": "importanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Description" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->RuleEvaluationPassed" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Site_Id" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Description" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsNonUsageBasedReadingRequired" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetTreeRegularAssetTaskSuppressedTaskRecursiveCollectionResourceActionResponse": { "title": "GetTreeRegularAssetTaskSuppressedTaskRecursiveCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTreeRegularAssetTaskSuppressedTaskRecursiveCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTreeRegularAssetTaskSuppressedTaskRecursiveCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->InheritedFrom_Id" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Description" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Asset_Id" }, "regularAssetTaskAssetTreePathItems": { "title": "regularAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskComponentId": { "title": "regularAssetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Component_Id" }, "regularAssetTaskComponentTreePathItems": { "title": "regularAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SequenceNumber" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTaskSuppressedTask->SuppressedDaysAfter gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTaskSuppressedTask->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" } } } }, "GetAuxiliaryAssetTaskResourceActionResponse": { "title": "GetAuxiliaryAssetTaskResourceActionResponse", "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": "GetAuxiliaryAssetTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Description" }, "assetTreePathId": { "title": "assetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_TreePathId" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Description" }, "componentQuantity": { "title": "componentQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Quantity" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentAssetId": { "title": "componentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Asset_Id" }, "componentAssetCode": { "title": "componentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Asset_Code" }, "componentAssetDescription": { "title": "componentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Asset_Description" }, "componentAssetRecordType": { "title": "componentAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "componentTreePathId": { "title": "componentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_TreePathId" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Unsynchronised" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AlternativeDescription" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->AssetType_Description" }, "assetTypeTreePathId": { "title": "assetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->AssetType_TreePathId" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateTotalDowntime" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateTotalDuration" }, "auxiliaryTaskType": { "title": "auxiliaryTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->AuxiliaryTaskType", "x-formatSpecifier": "AuxiliaryTaskType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->DurationPerUnit" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->InheritedFrom_Id" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->InheritedFrom_Description" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTask->InheritedFrom_LastConfirmedOn" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->IsSuppressed" }, "isSuppressor": { "title": "isSuppressor", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->IsSuppressor" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleSection_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceResourceType": { "title": "responsibleStaffMemberResourceResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_ResourceType", "x-formatSpecifier": "ResourceType" }, "responsibleStaffMemberResourceContactDetailId": { "title": "responsibleStaffMemberResourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailId" }, "responsibleStaffMemberResourceContactDetailFirstName": { "title": "responsibleStaffMemberResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailFirstName" }, "responsibleStaffMemberResourceContactDetailLastName": { "title": "responsibleStaffMemberResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_ContactDetailLastName" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleTrade_Description" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->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" } } }, "GetAuxiliaryAssetTaskCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->IsInherited" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->PermissionTree_Code" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Description" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->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" } } } }, "AuxiliaryAssetTaskChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskRegularAssetComponentLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskRegularAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskRegularAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskRegularAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetComponent->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" } } } }, "AuxiliaryAssetTaskRegularAssetLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTaskResponsibleSectionLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResponsibleSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResponsibleSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResponsibleSectionLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResponsibleTradeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResponsibleTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResponsibleTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResponsibleTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAuxiliaryAssetTaskResourceActionRequest": { "title": "CreateAuxiliaryAssetTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetId", "description", "labourDurationCalculationType", "autoCalculateTotalDowntime", "autoCalculateDurationPerUnit", "autoCalculateTotalDuration" ], "properties": { "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AlternativeDescription", "x-systemGenerated": true }, "auxiliaryTaskType": { "title": "auxiliaryTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->AuxiliaryTaskType", "x-formatSpecifier": "AuxiliaryTaskType" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Id" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateTotalDowntime" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateTotalDuration" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->DurationPerUnit" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->TotalDuration" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->PermissionTree_Id", "x-systemGenerated": true }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleTrade_Id" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleSection_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTaskResourceActionRequest": { "title": "UpdateAuxiliaryAssetTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTask->AlternativeDescription" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Notes" }, { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleTrade_Id" }, { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleStaffMemberResource_Id" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->ResponsibleSection_Id" }, { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateDurationPerUnit" }, { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateTotalDowntime" }, { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->AutoCalculateTotalDuration" }, { "title": "downtimePerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->DowntimePerUnit" }, { "title": "durationPerUnit", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->DurationPerUnit" }, { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->TotalDowntime" }, { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "AuxiliaryAssetTask->TotalDuration" } ] } } }, "DeleteAuxiliaryAssetTaskResourceActionRequest": { "title": "DeleteAuxiliaryAssetTaskResourceActionRequest", "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 } } }, "BatchGetAuxiliaryAssetTaskResourceAction": { "title": "BatchGetAuxiliaryAssetTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Task entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTaskResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTaskResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTaskResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTaskResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskResourceActionRequest" } }, "BatchDeleteAuxiliaryAssetTaskResourceActionRequest": { "title": "BatchDeleteAuxiliaryAssetTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskResourceActionRequest" } }, "ChangeAuxiliaryAssetTaskIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTask->IsActive" } ] } } }, "ChangeAuxiliaryAssetTaskPermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTask->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTaskIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskPermissionTreeResourceActionRequest" } }, "GetAuxiliaryAssetTaskResourceResourceActionResponse": { "title": "GetAuxiliaryAssetTaskResourceResourceActionResponse", "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": "GetAuxiliaryAssetTaskResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->LastConfirmedOn" }, "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->RulesLastEvaluatedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->PermissionTree_Description" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->AuxiliaryTask_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->InheritedFrom_LastConfirmedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->UnitOfMeasurement_Description" }, "unitOfMeasurementMeasurementType": { "title": "unitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->UnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTaskResource->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" } } }, "GetAuxiliaryAssetTaskResourceCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTaskResourceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTaskResourceCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->IsActive" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->AuxiliaryTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->SequenceNumber" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->InheritedFrom_Id" }, "inheritedFromResourceContactDetailFirstName": { "title": "inheritedFromResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->InheritedFrom_Resource_ContactDetailFirstName" }, "inheritedFromResourceContactDetailLastName": { "title": "inheritedFromResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->InheritedFrom_Resource_ContactDetailLastName" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Notes" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->RuleEvaluationPassed" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Unsynchronised" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskResource->SynchronisedWithTypeObjectUpTo" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetResourceForAuxiliaryAssetTaskCollectionResourceActionResponse": { "title": "GetResourceForAuxiliaryAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetResourceForAuxiliaryAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetResourceForAuxiliaryAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Description" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Description" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_ContactDetailLastName" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->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" } } } }, "AuxiliaryAssetTaskResourceTaskAuxiliaryAssetTaskLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceTaskAuxiliaryAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceTaskAuxiliaryAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceTaskAuxiliaryAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTaskResourceChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResourceCompetencyLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceCompetencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceCompetencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceCompetencyLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResourceResourceLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceResourceLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResourceSectionLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceSectionLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResourceTradeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceTradeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskResourceUnitOfMeasurementLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskResourceUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskResourceUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskResourceUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAuxiliaryAssetTaskResourceResourceActionRequest": { "title": "CreateAuxiliaryAssetTaskResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTaskResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "auxiliaryTaskId", "quantity", "tradeId" ], "properties": { "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->AuxiliaryTask_Id" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Id" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AuxiliaryAssetTaskResource->Usage", "x-systemGenerated": true, "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->PermissionTree_Id", "x-systemGenerated": true }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Id" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->ResourceType", "x-systemGenerated": true, "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->UnitOfMeasurement_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTaskResourceResourceActionRequest": { "title": "UpdateAuxiliaryAssetTaskResourceResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Competency_Id" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Notes" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Proficiency" }, { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Quantity" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Resource_Id" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->Section_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskResource->SequenceNumber" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->Trade_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskResource->UnitOfMeasurement_Id" } ] } } }, "DeleteAuxiliaryAssetTaskResourceResourceActionRequest": { "title": "DeleteAuxiliaryAssetTaskResourceResourceActionRequest", "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 } } }, "BatchGetAuxiliaryAssetTaskResourceResourceAction": { "title": "BatchGetAuxiliaryAssetTaskResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Task Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Task Resource entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTaskResourceResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTaskResourceResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTaskResourceResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTaskResourceResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskResourceResourceActionRequest" } }, "BatchDeleteAuxiliaryAssetTaskResourceResourceActionRequest": { "title": "BatchDeleteAuxiliaryAssetTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskResourceResourceActionRequest" } }, "ChangeAuxiliaryAssetTaskResourceIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskResourceIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTaskResource->IsActive" } ] } } }, "ChangeAuxiliaryAssetTaskResourcePermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskResourcePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTaskResource->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTaskResourceIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskResourceIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTaskResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskResourcePermissionTreeResourceActionRequest" } }, "GetAuxiliaryAssetTaskSpareResourceActionResponse": { "title": "GetAuxiliaryAssetTaskSpareResourceActionResponse", "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": "GetAuxiliaryAssetTaskSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSpare->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSpare->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->PermissionTree_Description" }, "auxiliaryAssetTaskId": { "title": "auxiliaryAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id" }, "auxiliaryAssetTaskCode": { "title": "auxiliaryAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Code" }, "auxiliaryAssetTaskDescription": { "title": "auxiliaryAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_LastConfirmedOn" }, "inheritedFromPreferredMaterialMasterId": { "title": "inheritedFromPreferredMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id" }, "inheritedFromPreferredMaterialMasterCode": { "title": "inheritedFromPreferredMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code" }, "inheritedFromPreferredMaterialMasterDescription": { "title": "inheritedFromPreferredMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Id" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_MaterialMaster_Code" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Warehouse_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" } } }, "GetAuxiliaryAssetTaskSpareCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTaskSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTaskSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "inheritedFromPreferredMaterialMasterId": { "title": "inheritedFromPreferredMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id" }, "inheritedFromPreferredMaterialMasterCode": { "title": "inheritedFromPreferredMaterialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code" }, "inheritedFromPreferredMaterialMasterDescription": { "title": "inheritedFromPreferredMaterialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->IsInherited" }, "auxiliaryAssetTaskId": { "title": "auxiliaryAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id" }, "auxiliaryAssetTaskCode": { "title": "auxiliaryAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Code" }, "auxiliaryAssetTaskDescription": { "title": "auxiliaryAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Description" }, "auxiliaryAssetTaskAssetTreePathItems": { "title": "auxiliaryAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "auxiliaryAssetTaskComponentTreePathItems": { "title": "auxiliaryAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Warehouse_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->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" } } } }, "GetSpareForAuxiliaryAssetTaskCollectionResourceActionResponse": { "title": "GetSpareForAuxiliaryAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForAuxiliaryAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForAuxiliaryAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->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" } } } }, "AuxiliaryAssetTaskSpareTaskAuxiliaryAssetTaskLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareTaskAuxiliaryAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareTaskAuxiliaryAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareTaskAuxiliaryAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTaskSpareChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskSpareCommodityLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareCommodityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareCommodityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareCommodityLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskSpareCostElementLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskSpareMaterialMasterLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" }, "commodityDescription": { "title": "commodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Description" }, "commodityCode": { "title": "commodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Commodity_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" } } } }, "AuxiliaryAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AuxiliaryAssetTaskSpareStockItemLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSpareStockItemLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSpareStockItemLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSpareStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateAuxiliaryAssetTaskSpareResourceActionRequest": { "title": "CreateAuxiliaryAssetTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "auxiliaryAssetTaskId", "stockItemId", "costElementId", "quantity" ], "properties": { "auxiliaryAssetTaskId": { "title": "auxiliaryAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->AuxiliaryAssetTask_Id" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Id", "x-systemGenerated": true }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->PermissionTree_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->Quantity" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTaskSpareResourceActionRequest": { "title": "UpdateAuxiliaryAssetTaskSpareResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->StockItem_Id" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->MaterialMaster_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSpare->CostElement_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->Notes" }, { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->Quantity" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSpare->SequenceNumber" } ] } } }, "DeleteAuxiliaryAssetTaskSpareResourceActionRequest": { "title": "DeleteAuxiliaryAssetTaskSpareResourceActionRequest", "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 } } }, "BatchGetAuxiliaryAssetTaskSpareResourceAction": { "title": "BatchGetAuxiliaryAssetTaskSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Task Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Task Spare entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTaskSpareResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTaskSpareResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTaskSpareResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTaskSpareResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskSpareResourceActionRequest" } }, "BatchDeleteAuxiliaryAssetTaskSpareResourceActionRequest": { "title": "BatchDeleteAuxiliaryAssetTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskSpareResourceActionRequest" } }, "ChangeAuxiliaryAssetTaskSpareIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskSpareIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTaskSpare->IsActive" } ] } } }, "ChangeAuxiliaryAssetTaskSparePermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskSparePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTaskSpare->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTaskSpareIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSpareIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTaskSparePermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSparePermissionTreeResourceActionRequest" } }, "GetAuxiliaryAssetTaskSubTaskResourceActionResponse": { "title": "GetAuxiliaryAssetTaskSubTaskResourceActionResponse", "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": "GetAuxiliaryAssetTaskSubTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSubTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSubTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Unsynchronised" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSubTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSubTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->PermissionTree_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AlternativeDescription" }, "auxiliaryAssetTaskId": { "title": "auxiliaryAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id" }, "auxiliaryAssetTaskCode": { "title": "auxiliaryAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Code" }, "auxiliaryAssetTaskDescription": { "title": "auxiliaryAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AuxiliaryAssetTaskSubTask->InheritedFrom_LastConfirmedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->RecordType", "x-formatSpecifier": "AssetTaskRecordType" } } }, "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" } } }, "GetAuxiliaryAssetTaskSubTaskCollectionResourceActionResponse": { "title": "GetAuxiliaryAssetTaskSubTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAuxiliaryAssetTaskSubTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAuxiliaryAssetTaskSubTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "auxiliaryAssetTaskId": { "title": "auxiliaryAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id" }, "auxiliaryAssetTaskCode": { "title": "auxiliaryAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Code" }, "auxiliaryAssetTaskDescription": { "title": "auxiliaryAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Description" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AlternativeDescription" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->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" } } } }, "GetSubTaskForAuxiliaryAssetTaskCollectionResourceActionResponse": { "title": "GetSubTaskForAuxiliaryAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSubTaskForAuxiliaryAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSubTaskForAuxiliaryAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AlternativeDescription" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->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" } } } }, "AuxiliaryAssetTaskSubTaskTaskAuxiliaryAssetTaskLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSubTaskTaskAuxiliaryAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSubTaskTaskAuxiliaryAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSubTaskTaskAuxiliaryAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Component_Code" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_Code" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "AuxiliaryAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->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" } } } }, "AuxiliaryAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AuxiliaryAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "AuxiliaryAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AuxiliaryAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AuxiliaryAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAuxiliaryAssetTaskSubTaskResourceActionRequest": { "title": "CreateAuxiliaryAssetTaskSubTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAuxiliaryAssetTaskSubTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "auxiliaryAssetTaskId", "description" ], "properties": { "auxiliaryAssetTaskId": { "title": "auxiliaryAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AuxiliaryAssetTask_Id" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AlternativeDescription" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAuxiliaryAssetTaskSubTaskResourceActionRequest": { "title": "UpdateAuxiliaryAssetTaskSubTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTaskSubTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Notes" }, { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Code" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->Description" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTaskSubTask->AlternativeDescription" } ] } } }, "DeleteAuxiliaryAssetTaskSubTaskResourceActionRequest": { "title": "DeleteAuxiliaryAssetTaskSubTaskResourceActionRequest", "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 } } }, "BatchGetAuxiliaryAssetTaskSubTaskResourceAction": { "title": "BatchGetAuxiliaryAssetTaskSubTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Auxiliary Asset Task Sub Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Auxiliary Asset Task Sub Task entities", "items": { "$ref": "#/definitions/GetAuxiliaryAssetTaskSubTaskResourceActionResponse" } }, "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" } } }, "BatchCreateAuxiliaryAssetTaskSubTaskResourceActionRequest": { "title": "BatchCreateAuxiliaryAssetTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, "BatchUpdateAuxiliaryAssetTaskSubTaskResourceActionRequest": { "title": "BatchUpdateAuxiliaryAssetTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, "BatchDeleteAuxiliaryAssetTaskSubTaskResourceActionRequest": { "title": "BatchDeleteAuxiliaryAssetTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAuxiliaryAssetTaskSubTaskResourceActionRequest" } }, "ChangeAuxiliaryAssetTaskSubTaskIsActiveResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskSubTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTaskSubTask->IsActive" } ] } } }, "ChangeAuxiliaryAssetTaskSubTaskPermissionTreeResourceActionRequest": { "title": "ChangeAuxiliaryAssetTaskSubTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "AuxiliaryAssetTaskSubTask->PermissionTree_Id" } ] } } }, "BatchChangeAuxiliaryAssetTaskSubTaskIsActiveResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskSubTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSubTaskIsActiveResourceActionRequest" } }, "BatchChangeAuxiliaryAssetTaskSubTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeAuxiliaryAssetTaskSubTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAuxiliaryAssetTaskSubTaskPermissionTreeResourceActionRequest" } }, "GeoJsonObject": { "type": "object", "discriminator": "type", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeoJsonObjectType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ] }, "bbox": { "title": "bbox", "type": "array", "items": { "type": "number" } } } }, "Feature": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.2", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "required": [ "geometry", "properties" ], "properties": { "geometry": { "allOf": [ { "x-nullable": true }, { "$ref": "#/definitions/Geometry" } ] }, "properties": { "type": "object", "x-nullable": true }, "id": { "oneOf": [ { "type": "number" }, { "type": "string" } ] } } } ] }, "FeatureCollection": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.3", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "required": [ "features" ], "properties": { "features": { "type": "array", "items": { "$ref": "#/definitions/Feature" } } } } ] }, "LinearRing": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.6", "minItems": 4, "items": { "$ref": "#/definitions/Position" } }, "LineStringCoordinates": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.4", "minItems": 2, "items": { "$ref": "#/definitions/Position" } }, "Position": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.1", "maxItems": 3, "minItems": 2, "items": { "type": "number" } }, "GeometryElement": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1", "allOf": [ { "$ref": "#/definitions/Geometry" }, { "type": "object", "discriminator": "type", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeometryElementType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon" ] } } } ] }, "GeometryCollection": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.8", "allOf": [ { "$ref": "#/definitions/Geometry" }, { "type": "object", "required": [ "geometries" ], "properties": { "geometries": { "type": "array", "items": { "$ref": "#/definitions/GeometryElement" } } } } ] }, "Geometry": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "discriminator": "type", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeometryType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection" ] } } } ] }, "Point": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.2", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/definitions/Position" } } } ] }, "MultiPoint": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.3", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/Position" } } } } ] }, "LineString": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.4", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/definitions/LineStringCoordinates" } } } ] }, "MultiLineString": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.5", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/LineStringCoordinates" } } } } ] }, "Polygon": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.6", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/LinearRing" } } } } ] }, "MultiPolygon": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.7", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/LinearRing" } } } } } ] }, "GetInPlaceAssetResourceActionResponse": { "title": "GetInPlaceAssetResourceActionResponse", "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": "GetInPlaceAssetResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Calendar_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Calendar_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CostCentre_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAsset->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeneralLedger_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->LastConfirmedOn" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Description" }, "nearestRegularAssetId": { "title": "nearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->NearestRegularAsset_Id" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->ParentAsset_Id" }, "parentAssetCode": { "title": "parentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ParentAsset_Code" }, "parentAssetDescription": { "title": "parentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ParentAsset_Description" }, "parentAssetRecordType": { "title": "parentAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ParentAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SequenceNumber" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Site_Description" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Unsynchronised" }, "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->RulesLastEvaluatedOn" }, "unsubscribed": { "title": "unsubscribed", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Unsubscribed" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "InPlaceAsset->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicUnitOfMeasurement_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "InPlaceAsset->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Id" }, "acquisitionStatusCode": { "title": "acquisitionStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Code" }, "acquisitionStatusDescription": { "title": "acquisitionStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Description" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionType_Id" }, "acquisitionTypeCode": { "title": "acquisitionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionType_Code" }, "acquisitionTypeDescription": { "title": "acquisitionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionType_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetImportance_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetType_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Barcode" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->BudgetedReplacementAmount" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->CommissionedOn" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Description" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CurrentValue" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->DateOfCurrentValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->DowntimeCostPerHour" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->ExpectedReplacementDate" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->InheritedFrom_LastConfirmedOn" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->InsuredValue" }, "isForScheduledWorkOnly": { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsForScheduledWorkOnly" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsMsi" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsPermitRequired" }, "isRunning": { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsRunning" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Notes" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->PurchaseAmount" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->QRCode" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAsset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Id" }, "replacementAssetCode": { "title": "replacementAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Code" }, "replacementAssetDescription": { "title": "replacementAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Description" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SerialNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Supplier_Description" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->TaskRollUpPoint_Description" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } }, "GetInPlaceAssetCollectionResourceActionResponse": { "title": "GetInPlaceAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsActive" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAsset->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsInherited" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->LastConfirmedOn" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ParentAsset_Id" }, "parentAssetCode": { "title": "parentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ParentAsset_Code" }, "parentAssetDescription": { "title": "parentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ParentAsset_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetType_Description" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->QRCode" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SerialNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SequenceNumber" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Barcode" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAsset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Location_Description" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->AssetImportance_Description" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Calendar_Id" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Calendar_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Description" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Description" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->PurchaseAmount" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CurrentValue" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->InheritedFrom_Id" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsMsi" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Supplier_Description" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionType_Id" }, "acquisitionTypeCode": { "title": "acquisitionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->AcquisitionType_Code" }, "acquisitionTypeDescription": { "title": "acquisitionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->AcquisitionType_Description" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Id" }, "acquisitionStatusCode": { "title": "acquisitionStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Code" }, "acquisitionStatusDescription": { "title": "acquisitionStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Description" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Id" }, "replacementAssetCode": { "title": "replacementAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Code" }, "replacementAssetDescription": { "title": "replacementAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Description" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->BudgetedReplacementAmount" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->DowntimeCostPerHour" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->InsuredValue" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->CommissionedOn" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->ExpectedReplacementDate" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->DateOfCurrentValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Notes" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RuleEvaluationPassed" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAsset->ModifiedOn" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "InPlaceAsset->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" } } } }, "InPlaceAssetAcquisitionStatusLookupResourceActionResponse": { "title": "InPlaceAssetAcquisitionStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAcquisitionStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAcquisitionStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionStatus->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetAcquisitionTypeLookupResourceActionResponse": { "title": "InPlaceAssetAcquisitionTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAcquisitionTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAcquisitionTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetAssetParentLookupResourceActionResponse": { "title": "InPlaceAssetAssetParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAssetParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAssetParentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetAssetTypeParentLookupResourceActionResponse": { "title": "InPlaceAssetAssetTypeParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAssetTypeParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAssetTypeParentLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetCalendarLookupResourceActionResponse": { "title": "InPlaceAssetCalendarLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetCalendarLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetCalendarLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetCommissioningWorkOrderLookupResourceActionResponse": { "title": "InPlaceAssetCommissioningWorkOrderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetCommissioningWorkOrderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetCommissioningWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetCostCentreLookupResourceActionResponse": { "title": "InPlaceAssetCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetGeneralLedgerLookupResourceActionResponse": { "title": "InPlaceAssetGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetImportanceLookupResourceActionResponse": { "title": "InPlaceAssetImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetImportanceLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetLocationLookupResourceActionResponse": { "title": "InPlaceAssetLocationLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetLocationLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetLocationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetReplacementAssetLookupResourceActionResponse": { "title": "InPlaceAssetReplacementAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetReplacementAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetReplacementAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetSiteLookupResourceActionResponse": { "title": "InPlaceAssetSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetSiteLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetSupplierLookupResourceActionResponse": { "title": "InPlaceAssetSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceRegularAssetTaskRollUpPointLookupResourceActionResponse": { "title": "InPlaceRegularAssetTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceRegularAssetTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceRegularAssetTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetResourceActionRequest": { "title": "CreateInPlaceAssetResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "description", "isForScheduledWorkOnly", "parentAssetId", "generalLedgerId", "costCentreId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAsset->AlternativeDescription", "x-systemGenerated": true }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsMsi" }, "isForScheduledWorkOnly": { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsForScheduledWorkOnly" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAsset->ParentAsset_Id" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsPermitRequired" }, "isRunning": { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsRunning" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->QRCode" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SerialNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SequenceNumber" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Barcode" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Id" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetImportance_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAsset->TaskRollUpPoint_Id" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Calendar_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Id" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Id" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Id" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->PurchaseAmount" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CurrentValue" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Supplier_Id" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionType_Id" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Id" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Id" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->BudgetedReplacementAmount" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->DowntimeCostPerHour" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->InsuredValue" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->CommissionedOn" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->ExpectedReplacementDate" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->DateOfCurrentValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Notes" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "InPlaceAsset->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetResourceActionRequest": { "title": "UpdateInPlaceAssetResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAsset->Code", "x-ReadOnlyExpression": "InPlaceAsset->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description", "x-ReadOnlyExpression": "InPlaceAsset->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAsset->AlternativeDescription" }, { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->QRCode" }, { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RFId" }, { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SerialNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SequenceNumber" }, { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Barcode" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsPermitRequired" }, { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsRunning" }, { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsMsi" }, { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsForScheduledWorkOnly" }, { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAsset->TaskRollUpPoint_Id" }, { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Calendar_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->PurchaseAmount" }, { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CurrentValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Supplier_Id" }, { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionType_Id" }, { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Id" }, { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Id" }, { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->BudgetedReplacementAmount" }, { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->DowntimeCostPerHour" }, { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->InsuredValue" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->CommissionedOn" }, { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->ExpectedReplacementDate" }, { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->DateOfCurrentValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Notes" }, { "title": "geographicLocation", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeographicReferenceEntityId" } ] } } }, "DeleteInPlaceAssetResourceActionRequest": { "title": "DeleteInPlaceAssetResourceActionRequest", "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 } } }, "BatchGetInPlaceAssetResourceAction": { "title": "BatchGetInPlaceAssetResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset entities", "items": { "$ref": "#/definitions/GetInPlaceAssetResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetResourceActionRequest": { "title": "BatchCreateInPlaceAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetResourceActionRequest" } }, "BatchUpdateInPlaceAssetResourceActionRequest": { "title": "BatchUpdateInPlaceAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetResourceActionRequest" } }, "BatchDeleteInPlaceAssetResourceActionRequest": { "title": "BatchDeleteInPlaceAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteInPlaceAssetResourceActionRequest" } }, "ChangeInPlaceAssetIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAsset->IsActive" } ] } } }, "ChangeInPlaceAssetPermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAsset->PermissionTree_Id" } ] } } }, "ResubscribeInPlaceAssetDevelopmentStatusResourceActionRequest": { "title": "ResubscribeInPlaceAssetDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ResubscribeInPlaceAssetDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UnsubscribeInPlaceAssetDevelopmentStatusResourceActionRequest": { "title": "UnsubscribeInPlaceAssetDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "UnsubscribeInPlaceAssetDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeInPlaceAssetIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetPermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetPermissionTreeResourceActionRequest" } }, "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 } } }, "MatchUpdateInPlaceAssetResourceActionRequest": { "title": "MatchUpdateInPlaceAssetResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description", "x-ReadOnlyExpression": "InPlaceAsset->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "InPlaceAsset->AlternativeDescription" }, { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->QRCode" }, { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->RFId" }, { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SerialNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAsset->SequenceNumber" }, { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Barcode" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsPermitRequired" }, { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsRunning" }, { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAsset->IsMsi" }, { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAsset->IsForScheduledWorkOnly" }, { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAsset->TaskRollUpPoint_Id" }, { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Calendar_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CommissioningWorkOrder_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Id", "x-NullExpression": "InPlaceAsset->IsMsi eq true" }, { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->PurchaseAmount" }, { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CurrentValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Supplier_Id" }, { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionType_Id" }, { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->AcquisitionStatus_Id" }, { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->ReplacementAsset_Id" }, { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->BudgetedReplacementAmount" }, { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->DowntimeCostPerHour" }, { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAsset->InsuredValue" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->CommissionedOn" }, { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->ExpectedReplacementDate" }, { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "InPlaceAsset->DateOfCurrentValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Notes" } ] } } }, "GetInPlaceAssetAttributeResourceActionResponse": { "title": "GetInPlaceAssetAttributeResourceActionResponse", "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": "GetInPlaceAssetAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->InheritedFrom_Id" }, "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->InPlaceAsset_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->SynchronisedWithTypeObjectUpTo" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->IsHistorical" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Unsynchronised" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->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" } } }, "GetInPlaceAssetAttributeCollectionForInPlaceAssetResourceActionResponse": { "title": "GetInPlaceAssetAttributeCollectionForInPlaceAssetResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetAttributeCollectionForInPlaceAssetResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetAttributeCollectionForInPlaceAssetResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->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" } } } }, "GetInPlaceAssetAttributeCollectionResourceActionResponse": { "title": "GetInPlaceAssetAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->IsInherited" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->InPlaceAsset_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetAttribute->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" } } } }, "InPlaceAssetAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "InPlaceAssetAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetAttributeAttributeLookupResourceActionResponse": { "title": "InPlaceAssetAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetAttributeRegularAssetTaskLookupResourceActionResponse": { "title": "InPlaceAssetAttributeRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAttributeRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAttributeRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetAttributeResourceActionRequest": { "title": "CreateInPlaceAssetAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetId", "attributeId" ], "properties": { "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->InPlaceAsset_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "InPlaceAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetAttributeResourceActionRequest": { "title": "UpdateInPlaceAssetAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetAttribute->Notes" } ] } } }, "DeleteInPlaceAssetAttributeResourceActionRequest": { "title": "DeleteInPlaceAssetAttributeResourceActionRequest", "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 } } }, "BatchGetInPlaceAssetAttributeResourceAction": { "title": "BatchGetInPlaceAssetAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Attribute entities", "items": { "$ref": "#/definitions/GetInPlaceAssetAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetAttributeResourceActionRequest": { "title": "BatchCreateInPlaceAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetAttributeResourceActionRequest" } }, "BatchUpdateInPlaceAssetAttributeResourceActionRequest": { "title": "BatchUpdateInPlaceAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetAttributeResourceActionRequest" } }, "BatchDeleteInPlaceAssetAttributeResourceActionRequest": { "title": "BatchDeleteInPlaceAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteInPlaceAssetAttributeResourceActionRequest" } }, "ChangeInPlaceAssetAttributeIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetAttribute->IsActive" } ] } } }, "ChangeInPlaceAssetAttributePermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetAttributePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetAttribute->PermissionTree_Id" } ] } } }, "BatchChangeInPlaceAssetAttributeIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetAttributeIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetAttributePermissionTreeResourceActionRequest" } }, "GetInPlaceAssetConsumptionResourceActionResponse": { "title": "GetInPlaceAssetConsumptionResourceActionResponse", "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": "GetInPlaceAssetConsumptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->PermissionTree_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->ConsumedOn" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Currency_Description" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRate_Id" }, "currencyRateUserSuppliedConversionRate": { "title": "currencyRateUserSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRate_UserSuppliedConversionRate" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRate_AppliedConversionRate" }, "currencyRateValue": { "title": "currencyRateValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRateValue" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Location_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Meter_Id", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Meter_Description" }, "meterUnitOfMeasurementId": { "title": "meterUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Meter_UnitOfMeasurement_Id" }, "meterUnitOfMeasurementCode": { "title": "meterUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Meter_UnitOfMeasurement_Code" }, "meterUnitOfMeasurementDescription": { "title": "meterUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Meter_UnitOfMeasurement_Description" }, "meterReadingId": { "title": "meterReadingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->MeterReading_Id" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->MeterReadingOn", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingValue ne NULL" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->MeterReadingValue", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Site_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->SiteCurrency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->SiteCurrency_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_AlternativeDescription" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_MaterialMaster_Description" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Warehouse_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Description" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->TotalCostInSiteCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitPrice" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostingCollectionForInPlaceAssetConsumptionResourceActionResponse": { "title": "GetCostingCollectionForInPlaceAssetConsumptionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostingCollectionForInPlaceAssetConsumptionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostingCollectionForInPlaceAssetConsumptionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Description" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "totalCostInBaseCurrency": { "title": "totalCostInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInBaseCurrency" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetInPlaceAssetConsumptionCollectionResourceActionResponse": { "title": "GetInPlaceAssetConsumptionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetConsumptionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetConsumptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->ConsumedOn" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Description" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRate_Id" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRate_AppliedConversionRate" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Description" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Description" }, "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Description" }, "inPlaceAssetRecordType": { "title": "inPlaceAssetRecordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Site_Description" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->MeterReadingOn", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingValue ne NULL" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->MeterReadingValue", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Meter_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->SiteCurrency_Code" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_AlternativeDescription" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Description" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->TotalCostInSiteCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitPrice" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetInPlaceAssetConsumptionForAssetCollectionResourceActionResponse": { "title": "GetInPlaceAssetConsumptionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetConsumptionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetConsumptionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->ConsumedOn" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_AlternativeDescription" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Quantity" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Site_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Meter_Description" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->MeterReadingValue", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->MeterReadingOn", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->SiteCurrency_Code" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRate_Id" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CurrencyRate_AppliedConversionRate" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitPrice" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->TotalCostInSiteCurrency" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetConsumptionConsumableLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionConsumableLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionConsumableLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionConsumableLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Consumable->UnitPrice" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionCostCentreLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionCostElementLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetConsumptionCurrencyLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionCurrencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionFinancialYearPeriodLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionFinancialYearPeriodLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionFinancialYearPeriodLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionGeneralLedgerLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionInPlaceAssetLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionInPlaceAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionInPlaceAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionInPlaceAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Site_Id" }, "siteFinancialYearPeriodId": { "title": "siteFinancialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Site_FinancialYearPeriod_Id" }, "siteFinancialYearPeriodCode": { "title": "siteFinancialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_FinancialYearPeriod_Code" }, "siteFinancialYearPeriodDescription": { "title": "siteFinancialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_FinancialYearPeriod_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Site_Currency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Currency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Currency_Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->CostCentre_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->GeneralLedger_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Location_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetConsumptionMeterLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionMeterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionResourceLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionResourceLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetConsumptionStockItemLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionStockItemLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionStockItemLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionSupplierLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->Site_Currency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Currency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Currency_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetConsumptionUnitOfMeasurementLookupResourceActionResponse": { "title": "InPlaceAssetConsumptionUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetConsumptionUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetConsumptionUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateInPlaceAssetConsumptionResourceActionRequest": { "title": "CreateInPlaceAssetConsumptionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetConsumptionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetId", "consumableId", "quantity" ], "properties": { "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->InPlaceAsset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->PermissionTree_Id", "x-systemGenerated": true }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Id" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Id" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->ConsumedOn", "x-systemGenerated": true }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Id", "x-systemGenerated": true }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitPrice", "x-systemGenerated": true }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Quantity" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Meter_Id", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->MeterReadingValue", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->MeterReadingOn", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Id" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Currency_Id", "x-systemGenerated": true }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Id", "x-systemGenerated": true }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetConsumptionResourceActionRequest": { "title": "UpdateInPlaceAssetConsumptionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Resource_Id" }, { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Consumable_Id" }, { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->ConsumedOn" }, { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->StockItem_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitOfMeasurement_Id" }, { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Quantity" }, { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Meter_Id", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, { "title": "meterReadingValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->MeterReadingValue", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingOn ne NULL" }, { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetConsumption->MeterReadingOn", "x-NullExpression": "InPlaceAssetConsumption->MeterReadingValue ne NULL" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Supplier_Id" }, { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->Currency_Id" }, { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->UnitPrice" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->CostElement_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->GeneralLedger_Id" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetConsumption->FinancialYearPeriod_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetConsumption->Notes" } ] } } }, "DeleteInPlaceAssetConsumptionResourceActionRequest": { "title": "DeleteInPlaceAssetConsumptionResourceActionRequest", "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 } } }, "BatchGetInPlaceAssetConsumptionResourceAction": { "title": "BatchGetInPlaceAssetConsumptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Consumption entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Consumption entities", "items": { "$ref": "#/definitions/GetInPlaceAssetConsumptionResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetConsumptionResourceActionRequest": { "title": "BatchCreateInPlaceAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetConsumptionResourceActionRequest" } }, "BatchUpdateInPlaceAssetConsumptionResourceActionRequest": { "title": "BatchUpdateInPlaceAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetConsumptionResourceActionRequest" } }, "BatchDeleteInPlaceAssetConsumptionResourceActionRequest": { "title": "BatchDeleteInPlaceAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteInPlaceAssetConsumptionResourceActionRequest" } }, "ChangeInPlaceAssetConsumptionIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetConsumptionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetConsumption->IsActive" } ] } } }, "ChangeInPlaceAssetConsumptionPermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetConsumptionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetConsumption->PermissionTree_Id" } ] } } }, "ValidateAssetConsumptionMeterAdrResourceActionRequest": { "title": "ValidateAssetConsumptionMeterAdrResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ValidateAssetConsumptionMeterAdrResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ValidateMeterAdrEntity->Meter_Id" }, "meterReadingId": { "title": "meterReadingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ValidateMeterAdrEntity->MeterReading_Id" }, "readingValue": { "title": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ValidateMeterAdrEntity->ReadingValue" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ValidateMeterAdrEntity->ReadingOn" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeInPlaceAssetConsumptionIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetConsumptionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetConsumptionIsActiveResourceActionRequest" } }, "GetInPlaceAssetMeterResourceActionResponse": { "title": "GetInPlaceAssetMeterResourceActionResponse", "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": "GetInPlaceAssetMeterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetMeter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetMeter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->PermissionTree_Description" }, "assetMeterType": { "title": "assetMeterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->AssetMeterType", "x-formatSpecifier": "EntityType" }, "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->InPlaceAsset_Description" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->IsMainMeter" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->Meter_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->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" } } }, "GetInPlaceAssetMeterCollectionResourceActionResponse": { "title": "GetInPlaceAssetMeterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetMeterCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->InPlaceAsset_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->Meter_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->IsActive" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->IsMainMeter" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->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" } } } }, "GetInPlaceAssetMeterForAssetCollectionResourceActionResponse": { "title": "GetInPlaceAssetMeterForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetMeterForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetMeterForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->Meter_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->IsActive" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->IsMainMeter" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->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" } } } }, "InPlaceAssetMeterAssetLookupResourceActionResponse": { "title": "InPlaceAssetMeterAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetMeterAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetMeterAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetMeterChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetMeterChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetMeterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetMeterChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetMeterInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetMeterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetMeterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetMeterInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetMeterMeterLookupResourceActionResponse": { "title": "InPlaceAssetMeterMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetMeterMeterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetMeterMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateInPlaceAssetMeterResourceActionRequest": { "title": "CreateInPlaceAssetMeterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetMeterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetId", "meterId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->PermissionTree_Id", "x-systemGenerated": true }, "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->InPlaceAsset_Id" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->Meter_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetMeterResourceActionRequest": { "title": "UpdateInPlaceAssetMeterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetMeter->SequenceNumber" }, { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetMeter->IsMainMeter" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetMeter->Notes" } ] } } }, "DeleteInPlaceAssetMeterResourceActionRequest": { "title": "DeleteInPlaceAssetMeterResourceActionRequest", "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 } } }, "BatchGetInPlaceAssetMeterResourceAction": { "title": "BatchGetInPlaceAssetMeterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Meter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Meter entities", "items": { "$ref": "#/definitions/GetInPlaceAssetMeterResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetMeterResourceActionRequest": { "title": "BatchCreateInPlaceAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetMeterResourceActionRequest" } }, "BatchUpdateInPlaceAssetMeterResourceActionRequest": { "title": "BatchUpdateInPlaceAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetMeterResourceActionRequest" } }, "BatchDeleteInPlaceAssetMeterResourceActionRequest": { "title": "BatchDeleteInPlaceAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteInPlaceAssetMeterResourceActionRequest" } }, "ChangeInPlaceAssetMeterIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetMeterIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetMeter->IsActive" } ] } } }, "SetMainInPlaceAssetMeterStatusResourceActionRequest": { "title": "SetMainInPlaceAssetMeterStatusResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "SetInPlaceAssetMainMeterStatus->IsMainMeter" } ] } } }, "BatchChangeInPlaceAssetMeterIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetMeterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetMeterIsActiveResourceActionRequest" } }, "GetInPlaceAssetResponsibilityResourceActionResponse": { "title": "GetInPlaceAssetResponsibilityResourceActionResponse", "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": "GetInPlaceAssetResponsibilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetResponsibility->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetResponsibility->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetResponsibility->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetResponsibility->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->InheritedFrom_Id" }, "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->InPlaceAsset_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->RecordType", "x-formatSpecifier": "AssetRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Resource_ContactDetailLastName" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->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" } } }, "GetInPlaceAssetResponsibilityCollectionResourceActionResponse": { "title": "GetInPlaceAssetResponsibilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetResponsibilityCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetResponsibilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->IsActive" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->InPlaceAsset_Code" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Trade_Code" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Section_Code" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Resource_Code" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetInPlaceAssetResponsibilityForInPlaceAssetCollectionResourceActionResponse": { "title": "GetInPlaceAssetResponsibilityForInPlaceAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetResponsibilityForInPlaceAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetResponsibilityForInPlaceAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Resource_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Trade_Code" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Section_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->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" } } } }, "InPlaceAssetResponsibilityChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetResponsibilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetResponsibilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetResponsibilityChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetResponsibilityInPlaceAssetLookupResourceActionResponse": { "title": "InPlaceAssetResponsibilityInPlaceAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetResponsibilityInPlaceAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetResponsibilityInPlaceAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetResponsibilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetResponsibilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetResponsibilityResourceLookupResourceActionResponse": { "title": "InPlaceAssetResponsibilityResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetResponsibilityResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetResponsibilityResourceLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponse": { "title": "InPlaceAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetResponsibilitySectionLookupResourceActionResponse": { "title": "InPlaceAssetResponsibilitySectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetResponsibilitySectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetResponsibilitySectionLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetResponsibilityTradeLookupResourceActionResponse": { "title": "InPlaceAssetResponsibilityTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetResponsibilityTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetResponsibilityTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetResponsibilityResourceActionRequest": { "title": "CreateInPlaceAssetResponsibilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetResponsibilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->PermissionTree_Id", "x-systemGenerated": true }, "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->InPlaceAsset_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Section_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Trade_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Resource_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetResponsibilityResourceActionRequest": { "title": "UpdateInPlaceAssetResponsibilityResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetResponsibility->SequenceNumber" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetResponsibility->Resource_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetResponsibility->Notes" } ] } } }, "DeleteInPlaceAssetResponsibilityResourceActionRequest": { "title": "DeleteInPlaceAssetResponsibilityResourceActionRequest", "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 } } }, "BatchGetInPlaceAssetResponsibilityResourceAction": { "title": "BatchGetInPlaceAssetResponsibilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Responsibility entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Responsibility entities", "items": { "$ref": "#/definitions/GetInPlaceAssetResponsibilityResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetResponsibilityResourceActionRequest": { "title": "BatchCreateInPlaceAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetResponsibilityResourceActionRequest" } }, "BatchUpdateInPlaceAssetResponsibilityResourceActionRequest": { "title": "BatchUpdateInPlaceAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetResponsibilityResourceActionRequest" } }, "BatchDeleteInPlaceAssetResponsibilityResourceActionRequest": { "title": "BatchDeleteInPlaceAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteInPlaceAssetResponsibilityResourceActionRequest" } }, "ChangeInPlaceAssetResponsibilityIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetResponsibilityIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetResponsibility->IsActive" } ] } } }, "ChangeInPlaceAssetResponsibilityPermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetResponsibilityPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetResponsibility->PermissionTree_Id" } ] } } }, "BatchChangeInPlaceAssetResponsibilityIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetResponsibilityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetResponsibilityIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetResponsibilityPermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetResponsibilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetResponsibilityPermissionTreeResourceActionRequest" } }, "GetInPlaceAssetSpareResourceActionResponse": { "title": "GetInPlaceAssetSpareResourceActionResponse", "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": "GetInPlaceAssetSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetSpare->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetSpare->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "InPlaceAssetSpare->InheritedFrom_LastConfirmedOn" }, "inheritedFromMaterialMasterId": { "title": "inheritedFromMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->InheritedFrom_MaterialMaster_Id" }, "inheritedFromMaterialMasterCode": { "title": "inheritedFromMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->InheritedFrom_MaterialMaster_Code" }, "inheritedFromMaterialMasterDescription": { "title": "inheritedFromMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->InheritedFrom_MaterialMaster_Description" }, "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->InPlaceAsset_Description" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsEmergency" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "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" } } }, "GetInPlaceAssetSpareCollectionResourceActionResponse": { "title": "GetInPlaceAssetSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetInPlaceAssetSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetInPlaceAssetSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->InPlaceAsset_Id" }, "inPlaceAssetCode": { "title": "inPlaceAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->InPlaceAsset_Code" }, "inPlaceAssetDescription": { "title": "inPlaceAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->InPlaceAsset_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->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" } } } }, "GetSpareForInPlaceAssetCollectionResourceActionResponse": { "title": "GetSpareForInPlaceAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForInPlaceAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForInPlaceAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->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" } } } }, "InPlaceAssetSpareChangePermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetSpareInPlaceAssetLookupResourceActionResponse": { "title": "InPlaceAssetSpareInPlaceAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetSpareInPlaceAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetSpareInPlaceAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "InPlaceAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "InPlaceAssetSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "InPlaceAssetSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "InPlaceAssetSpareMaterialMasterLookupResourceActionResponse": { "title": "InPlaceAssetSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "InPlaceAssetSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "InPlaceAssetSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "CreateInPlaceAssetSpareResourceActionRequest": { "title": "CreateInPlaceAssetSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateInPlaceAssetSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "inPlaceAssetId", "materialMasterId", "isCritical", "isEmergency" ], "properties": { "inPlaceAssetId": { "title": "inPlaceAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "InPlaceAssetSpare->InPlaceAsset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->PermissionTree_Id", "x-systemGenerated": true }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->SequenceNumber" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsEmergency" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateInPlaceAssetSpareResourceActionRequest": { "title": "UpdateInPlaceAssetSpareResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetSpare->SequenceNumber" }, { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsCritical" }, { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->IsEmergency" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "InPlaceAssetSpare->Notes" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "InPlaceAssetSpare->MaterialMaster_Id" } ] } } }, "DeleteInPlaceAssetSpareResourceActionRequest": { "title": "DeleteInPlaceAssetSpareResourceActionRequest", "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 } } }, "BatchGetInPlaceAssetSpareResourceAction": { "title": "BatchGetInPlaceAssetSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of In-Place Asset Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of In-Place Asset Spare entities", "items": { "$ref": "#/definitions/GetInPlaceAssetSpareResourceActionResponse" } }, "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" } } }, "BatchCreateInPlaceAssetSpareResourceActionRequest": { "title": "BatchCreateInPlaceAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateInPlaceAssetSpareResourceActionRequest" } }, "BatchUpdateInPlaceAssetSpareResourceActionRequest": { "title": "BatchUpdateInPlaceAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateInPlaceAssetSpareResourceActionRequest" } }, "BatchDeleteInPlaceAssetSpareResourceActionRequest": { "title": "BatchDeleteInPlaceAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteInPlaceAssetSpareResourceActionRequest" } }, "ChangeInPlaceAssetSpareIsActiveResourceActionRequest": { "title": "ChangeInPlaceAssetSpareIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetSpare->IsActive" } ] } } }, "ChangeInPlaceAssetSparePermissionTreeResourceActionRequest": { "title": "ChangeInPlaceAssetSparePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "InPlaceAssetSpare->PermissionTree_Id" } ] } } }, "BatchChangeInPlaceAssetSpareIsActiveResourceActionRequest": { "title": "BatchChangeInPlaceAssetSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetSpareIsActiveResourceActionRequest" } }, "BatchChangeInPlaceAssetSparePermissionTreeResourceActionRequest": { "title": "BatchChangeInPlaceAssetSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeInPlaceAssetSparePermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetResourceActionResponse": { "title": "GetPlaceholderAssetResourceActionResponse", "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": "GetPlaceholderAssetResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Calendar_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Calendar_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->CostCentre_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CostCentre_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAsset->LastConfirmedOn" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Location_Description" }, "nearestRegularAssetId": { "title": "nearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->NearestRegularAsset_Id" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->ParentAsset_Id" }, "parentAssetCode": { "title": "parentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ParentAsset_Code" }, "parentAssetDescription": { "title": "parentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ParentAsset_Description" }, "parentAssetRecordType": { "title": "parentAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ParentAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SequenceNumber" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Site_Description" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAsset->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Unsynchronised" }, "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAsset->RulesLastEvaluatedOn" }, "unsubscribed": { "title": "unsubscribed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Unsubscribed" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "PlaceholderAsset->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicUnitOfMeasurement_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAsset->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAsset->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->PermissionTree_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAsset->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionStatus_Id" }, "acquisitionStatusCode": { "title": "acquisitionStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionStatus_Code" }, "acquisitionStatusDescription": { "title": "acquisitionStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionStatus_Description" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionType_Id" }, "acquisitionTypeCode": { "title": "acquisitionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionType_Code" }, "acquisitionTypeDescription": { "title": "acquisitionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionType_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetImportance_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetType_Id" }, "assetTypeRecordType": { "title": "assetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetType_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Barcode" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->BudgetedReplacementAmount" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->CommissionedOn" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CommissioningWorkOrder_Description" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CurrentValue" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->DateOfCurrentValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->DowntimeCostPerHour" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->ExpectedReplacementDate" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAsset->InheritedFrom_LastConfirmedOn" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->InsuredValue" }, "isForScheduledWorkOnly": { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsForScheduledWorkOnly" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->IsMsi" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsPermitRequired" }, "isRunning": { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsRunning" }, "linkedOnTypeSide": { "title": "linkedOnTypeSide", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->LinkedOnTypeSide" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Notes" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->PurchaseAmount" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->QRCode" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Id" }, "replacementAssetCode": { "title": "replacementAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Code" }, "replacementAssetDescription": { "title": "replacementAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Description" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SerialNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Supplier_Description" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->TaskRollUpPoint_Description" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } }, "GetPlaceholderAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->IsActive" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Code" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ParentAsset_Id" }, "parentAssetCode": { "title": "parentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ParentAsset_Code" }, "parentAssetDescription": { "title": "parentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ParentAsset_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetType_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->IsInherited" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->IsMsi" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->InheritedFrom_Id" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAsset->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->RuleEvaluationPassed" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAsset->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Id" }, "replacementAssetCode": { "title": "replacementAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Code" }, "replacementAssetDescription": { "title": "replacementAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetAcquisitionStatusLookupResourceActionResponse": { "title": "PlaceholderAssetAcquisitionStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAcquisitionStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAcquisitionStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionStatus->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetAcquisitionTypeLookupResourceActionResponse": { "title": "PlaceholderAssetAcquisitionTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAcquisitionTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAcquisitionTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetAssetParentLookupResourceActionResponse": { "title": "PlaceholderAssetAssetParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAssetParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAssetParentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetAssetTypeParentLookupResourceActionResponse": { "title": "PlaceholderAssetAssetTypeParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAssetTypeParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAssetTypeParentLookupResourceActionResponseItemProperties", "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" }, "canSelectOnAsset": { "title": "canSelectOnAsset", "type": "boolean", "x-nullable": true, "x-propertyPath": "AssetType->CanSelectOnAsset" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetCalendarLookupResourceActionResponse": { "title": "PlaceholderAssetCalendarLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetCalendarLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetCalendarLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetCommissioningWorkOrderLookupResourceActionResponse": { "title": "PlaceholderAssetCommissioningWorkOrderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetCommissioningWorkOrderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetCommissioningWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetCostCentreLookupResourceActionResponse": { "title": "PlaceholderAssetCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetGeneralLedgerLookupResourceActionResponse": { "title": "PlaceholderAssetGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetImportanceLookupResourceActionResponse": { "title": "PlaceholderAssetImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetImportanceLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetLocationLookupResourceActionResponse": { "title": "PlaceholderAssetLocationLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetLocationLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetLocationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetReplacementAssetLookupResourceActionResponse": { "title": "PlaceholderAssetReplacementAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetReplacementAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetReplacementAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetSiteLookupResourceActionResponse": { "title": "PlaceholderAssetSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetSiteLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetSupplierLookupResourceActionResponse": { "title": "PlaceholderAssetSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetTaskRollUpPointLookupResourceActionResponse": { "title": "PlaceholderAssetTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePlaceholderAssetResourceActionRequest": { "title": "CreatePlaceholderAssetResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "description", "isPermitRequired", "parentAssetId", "generalLedgerId", "costCentreId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAsset->AlternativeDescription", "x-systemGenerated": true }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->IsPermitRequired" }, "isRunning": { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsRunning" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAsset->ParentAsset_Id" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->QRCode" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SerialNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SequenceNumber" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Barcode" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Location_Id" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetImportance_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAsset->TaskRollUpPoint_Id" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CommissioningWorkOrder_Id" }, "isForScheduledWorkOnly": { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsForScheduledWorkOnly" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Calendar_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Id" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->CostCentre_Id" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->PurchaseAmount" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CurrentValue" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Supplier_Id" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionType_Id" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionStatus_Id" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->BudgetedReplacementAmount" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->DowntimeCostPerHour" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->InsuredValue" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->CommissionedOn" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->ExpectedReplacementDate" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->DateOfCurrentValue" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Notes" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "PlaceholderAsset->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetResourceActionRequest": { "title": "UpdatePlaceholderAssetResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAsset->Code", "x-ReadOnlyExpression": "PlaceholderAsset->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description", "x-ReadOnlyExpression": "PlaceholderAsset->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAsset->AlternativeDescription" }, { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->QRCode" }, { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->RFId" }, { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SerialNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SequenceNumber" }, { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Barcode" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsPermitRequired" }, { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsRunning" }, { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Location_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAsset->TaskRollUpPoint_Id" }, { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Calendar_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsForScheduledWorkOnly" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CommissioningWorkOrder_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->CostCentre_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->PurchaseAmount" }, { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CurrentValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Supplier_Id" }, { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionType_Id" }, { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionStatus_Id" }, { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->BudgetedReplacementAmount" }, { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->DowntimeCostPerHour" }, { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->InsuredValue" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->CommissionedOn" }, { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->ExpectedReplacementDate" }, { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->DateOfCurrentValue" }, { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Notes" }, { "title": "geographicLocation", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeographicReferenceEntityId" } ] } } }, "DeletePlaceholderAssetResourceActionRequest": { "title": "DeletePlaceholderAssetResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetResourceAction": { "title": "BatchGetPlaceholderAssetResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetResourceActionRequest": { "title": "BatchCreatePlaceholderAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetResourceActionRequest" } }, "BatchUpdatePlaceholderAssetResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetResourceActionRequest" } }, "BatchDeletePlaceholderAssetResourceActionRequest": { "title": "BatchDeletePlaceholderAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetResourceActionRequest" } }, "ChangePlaceholderAssetIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAsset->IsActive" } ] } } }, "ChangePlaceholderAssetPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAsset->PermissionTree_Id" } ] } } }, "ResubscribePlaceholderAssetDevelopmentStatusResourceActionRequest": { "title": "ResubscribePlaceholderAssetDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ResubscribePlaceholderAssetDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UnsubscribePlaceholderAssetDevelopmentStatusResourceActionRequest": { "title": "UnsubscribePlaceholderAssetDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "UnsubscribePlaceholderAssetDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangePlaceholderAssetIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetPermissionTreeResourceActionRequest" } }, "MatchUpdatePlaceholderAssetResourceActionRequest": { "title": "MatchUpdatePlaceholderAssetResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description", "x-ReadOnlyExpression": "PlaceholderAsset->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAsset->AlternativeDescription" }, { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->QRCode" }, { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->RFId" }, { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SerialNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->SequenceNumber" }, { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Barcode" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsPermitRequired" }, { "title": "isRunning", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsRunning" }, { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Location_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAsset->TaskRollUpPoint_Id" }, { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Calendar_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->IsForScheduledWorkOnly" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CommissioningWorkOrder_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->CostCentre_Id", "x-NullExpression": "PlaceholderAsset->IsMsi eq true" }, { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->PurchaseAmount" }, { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CurrentValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Supplier_Id" }, { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionType_Id" }, { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->AcquisitionStatus_Id" }, { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->BudgetedReplacementAmount" }, { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->DowntimeCostPerHour" }, { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->InsuredValue" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->CommissionedOn" }, { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->ExpectedReplacementDate" }, { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAsset->DateOfCurrentValue" }, { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->ReplacementAsset_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Notes" } ] } } }, "GetPlaceholderAssetActiveConditionResourceActionResponse": { "title": "GetPlaceholderAssetActiveConditionResourceActionResponse", "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": "GetPlaceholderAssetActiveConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetActiveCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetActiveCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PermissionTree_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_ConditionType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Notes" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Description" }, "placeholderAssetNearestRegularAssetId": { "title": "placeholderAssetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Id" }, "placeholderAssetNearestRegularAssetCode": { "title": "placeholderAssetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Code" }, "placeholderAssetNearestRegularAssetDescription": { "title": "placeholderAssetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_NearestRegularAsset_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->RecordType", "x-formatSpecifier": "AssetRecordType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->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" } } }, "GetPlaceholderAssetActiveConditionCollectionResourceActionResponse": { "title": "GetPlaceholderAssetActiveConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetActiveConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetActiveConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->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" } } } }, "GetPlaceholderAssetActiveConditionForAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetActiveConditionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetActiveConditionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetActiveConditionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->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" } } } }, "PlaceholderAssetActiveConditionChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetActiveConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetActiveConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetActiveConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetActiveConditionConditionLookupResourceActionResponse": { "title": "PlaceholderAssetActiveConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetActiveConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetActiveConditionConditionLookupResourceActionResponseItemProperties", "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" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Id" }, "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" } } } }, "PlaceholderAssetActiveConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetActiveConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetActiveConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetActiveConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetActiveConditionPlaceholderAssetLookupResourceActionResponse": { "title": "PlaceholderAssetActiveConditionPlaceholderAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetActiveConditionPlaceholderAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetActiveConditionPlaceholderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetActiveConditionRegularAssetLookupResourceActionResponse": { "title": "PlaceholderAssetActiveConditionRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetActiveConditionRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetActiveConditionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetActiveConditionResourceActionRequest": { "title": "CreatePlaceholderAssetActiveConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetActiveConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetId", "conditionId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->SequenceNumber" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetActiveCondition->PlaceholderAsset_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetActiveCondition->Condition_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetActiveConditionResourceActionRequest": { "title": "UpdatePlaceholderAssetActiveConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetActiveCondition->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetActiveCondition->Notes" } ] } } }, "DeletePlaceholderAssetActiveConditionResourceActionRequest": { "title": "DeletePlaceholderAssetActiveConditionResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetActiveConditionResourceAction": { "title": "BatchGetPlaceholderAssetActiveConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Active Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Active Condition entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetActiveConditionResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetActiveConditionResourceActionRequest": { "title": "BatchCreatePlaceholderAssetActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetActiveConditionResourceActionRequest" } }, "BatchUpdatePlaceholderAssetActiveConditionResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetActiveConditionResourceActionRequest" } }, "BatchDeletePlaceholderAssetActiveConditionResourceActionRequest": { "title": "BatchDeletePlaceholderAssetActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetActiveConditionResourceActionRequest" } }, "ChangePlaceholderAssetActiveConditionPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetActiveConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetActiveCondition->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetActiveConditionPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetActiveConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetActiveConditionPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetAttributeResourceActionResponse": { "title": "GetPlaceholderAssetAttributeResourceActionResponse", "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": "GetPlaceholderAssetAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->InheritedFrom_Id" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PlaceholderAsset_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->SynchronisedWithTypeObjectUpTo" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->IsHistorical" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Unsynchronised" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->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" } } }, "GetPlaceholderAssetAttributeCollectionForPlaceholderAssetResourceActionResponse": { "title": "GetPlaceholderAssetAttributeCollectionForPlaceholderAssetResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetAttributeCollectionForPlaceholderAssetResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetAttributeCollectionForPlaceholderAssetResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->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" } } } }, "GetPlaceholderAssetAttributeCollectionResourceActionResponse": { "title": "GetPlaceholderAssetAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->PlaceholderAsset_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetAttribute->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" } } } }, "PlaceholderAssetAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "PlaceholderAssetAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetAttributeAttributeLookupResourceActionResponse": { "title": "PlaceholderAssetAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetAttributePlaceholderAssetLookupResourceActionResponse": { "title": "PlaceholderAssetAttributePlaceholderAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetAttributePlaceholderAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetAttributePlaceholderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetAttributeResourceActionRequest": { "title": "CreatePlaceholderAssetAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetId", "attributeId" ], "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->PlaceholderAsset_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetAttributeResourceActionRequest": { "title": "UpdatePlaceholderAssetAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetAttribute->Notes" } ] } } }, "DeletePlaceholderAssetAttributeResourceActionRequest": { "title": "DeletePlaceholderAssetAttributeResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetAttributeResourceAction": { "title": "BatchGetPlaceholderAssetAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Attribute entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetAttributeResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetAttributeResourceActionRequest": { "title": "BatchCreatePlaceholderAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetAttributeResourceActionRequest" } }, "BatchUpdatePlaceholderAssetAttributeResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetAttributeResourceActionRequest" } }, "BatchDeletePlaceholderAssetAttributeResourceActionRequest": { "title": "BatchDeletePlaceholderAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetAttributeResourceActionRequest" } }, "ChangePlaceholderAssetAttributeIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetAttribute->IsActive" } ] } } }, "ChangePlaceholderAssetAttributePermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetAttributePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetAttribute->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetAttributeIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetAttributeIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetAttributePermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetAttributePermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetComponentResourceActionResponse": { "title": "GetPlaceholderAssetComponentResourceActionResponse", "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": "GetPlaceholderAssetComponentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->RulesLastEvaluatedOn" }, "unsubscribed": { "title": "unsubscribed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Unsubscribed" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetAssetTypeId": { "title": "assetAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_AssetType_Id" }, "assetAssetTypeRecordType": { "title": "assetAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetNearestRegularAssetId": { "title": "assetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_NearestRegularAsset_Id" }, "assetNearestRegularAssetCode": { "title": "assetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_NearestRegularAsset_Code" }, "assetNearestRegularAssetDescription": { "title": "assetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_NearestRegularAsset_Description" }, "assetTreePathId": { "title": "assetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_TreePathId" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->LastConfirmedOn" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ParentComponent_Description" }, "parentComponentTreePathId": { "title": "parentComponentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ParentComponent_TreePathId" }, "parentComponentTreePathItems": { "title": "parentComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->ParentComponent_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SequenceNumber" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Site_Description" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Unsynchronised" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetType_Description" }, "assetTypeTreePathId": { "title": "assetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetType_TreePathId" }, "assetTypeTreePathItems": { "title": "assetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->AssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Barcode" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAssetComponent->CommissionedOn" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->InheritedFrom_LastConfirmedOn" }, "inheritedFromRulesLastChangedOn": { "title": "inheritedFromRulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->InheritedFrom_RulesLastChangedOn" }, "inheritedFromTreePathId": { "title": "inheritedFromTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->InheritedFrom_TreePathId" }, "inheritedFromTreePathItems": { "title": "inheritedFromTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->InheritedFrom_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "linkedOnTypeSide": { "title": "linkedOnTypeSide", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->LinkedOnTypeSide" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_Description" }, "linkedToAssetTypeTreePathId": { "title": "linkedToAssetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_TreePathId" }, "linkedToAssetTypeTreePathItems": { "title": "linkedToAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Notes" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PartNumber" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_Description" }, "placeholderForAssetTypeTreePathId": { "title": "placeholderForAssetTypeTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_TreePathId" }, "placeholderForAssetTypeTreePathItems": { "title": "placeholderForAssetTypeTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->QRCode" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Quantity" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SerialNumber" }, "specification": { "title": "specification", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Specification" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Description" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SupplierPartNumber" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } }, "GetPlaceholderAssetComponentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PartNumber" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->QRCode" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->RFId" }, "specification": { "title": "specification", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Specification" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SupplierPartNumber" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAssetComponent->CommissionedOn" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Quantity" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetType_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Description" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Description" }, "placeholderForAssetTypeId": { "title": "placeholderForAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_Id" }, "placeholderForAssetTypeCode": { "title": "placeholderForAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_Code" }, "placeholderForAssetTypeDescription": { "title": "placeholderForAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->PlaceholderForAssetType_Description" }, "linkedToAssetTypeId": { "title": "linkedToAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_Id" }, "linkedToAssetTypeCode": { "title": "linkedToAssetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_Code" }, "linkedToAssetTypeDescription": { "title": "linkedToAssetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->LinkedToAssetType_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Site_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->InheritedFrom_Id" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->IsHistorical" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->ParentComponent_Code" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_Code" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->RuleEvaluationPassed" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponent->ModifiedOn" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "PlaceholderAssetComponent->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" } } } }, "AssetComponentPlaceholderParentComponentLookupResourceActionResponse": { "title": "AssetComponentPlaceholderParentComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetComponentPlaceholderParentComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetComponentPlaceholderParentComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentAssetLookupResourceActionResponse": { "title": "PlaceholderAssetComponentAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentCommissioningWorkOrderLookupResourceActionResponse": { "title": "PlaceholderAssetComponentCommissioningWorkOrderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentCommissioningWorkOrderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentCommissioningWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentImportanceLookupResourceActionResponse": { "title": "PlaceholderAssetComponentImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentImportanceLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentLinkedAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentLinkedAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentLinkedAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentLinkedAssetTypeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentsMaterialMasterLookupResourceActionResponse": { "title": "PlaceholderAssetComponentsMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentsMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentsMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentRegularAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentRegularAssetTypeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentsSiteLookupResourceActionResponse": { "title": "PlaceholderAssetComponentsSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentsSiteLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentsSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentSupplierLookupResourceActionResponse": { "title": "PlaceholderAssetComponentSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePlaceholderAssetComponentResourceActionRequest": { "title": "CreatePlaceholderAssetComponentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetComponentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetId", "description", "quantity" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponent->Asset_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->AlternativeDescription" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Site_Id", "x-systemGenerated": true }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponent->ParentComponent_Id" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponent->Quantity" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PartNumber" }, "barcode": { "title": "barcode", "type": "string", "maxLength": 900, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Barcode" }, "serialNumber": { "title": "serialNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SerialNumber" }, "qRCode": { "title": "qRCode", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->QRCode" }, "rFId": { "title": "rFId", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->RFId" }, "specification": { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Specification" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAssetComponent->CommissionedOn" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Id" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SupplierPartNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SequenceNumber" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Id" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetComponentResourceActionRequest": { "title": "UpdatePlaceholderAssetComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponent->Code", "x-ReadOnlyExpression": "PlaceholderAssetComponent->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description", "x-ReadOnlyExpression": "PlaceholderAssetComponent->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->AlternativeDescription" }, { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponent->Quantity" }, { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->PartNumber" }, { "title": "qRCode", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->QRCode" }, { "title": "rFId", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->RFId" }, { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Specification" }, { "title": "barcode", "type": "string", "maxLength": 900, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Barcode" }, { "title": "serialNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SerialNumber" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "PlaceholderAssetComponent->CommissionedOn" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SequenceNumber" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Supplier_Id" }, { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->SupplierPartNumber" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->AssetImportance_Id" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->MaterialMaster_Id" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->CommissioningWorkOrder_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponent->Notes" } ] } } }, "DeletePlaceholderAssetComponentResourceActionRequest": { "title": "DeletePlaceholderAssetComponentResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetComponentResourceAction": { "title": "BatchGetPlaceholderAssetComponentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Component entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Component entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetComponentResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetComponentResourceActionRequest": { "title": "BatchCreatePlaceholderAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetComponentResourceActionRequest" } }, "BatchUpdatePlaceholderAssetComponentResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentResourceActionRequest" } }, "BatchDeletePlaceholderAssetComponentResourceActionRequest": { "title": "BatchDeletePlaceholderAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetComponentResourceActionRequest" } }, "ChangePlaceholderAssetComponentIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetComponentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponent->IsActive" } ] } } }, "ChangePlaceholderAssetComponentPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetComponentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponent->PermissionTree_Id" } ] } } }, "ClearPlaceholderAssetComponentResourceActionRequest": { "title": "ClearPlaceholderAssetComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } } } }, "LinkPlaceholderAssetComponentResourceActionRequest": { "title": "LinkPlaceholderAssetComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "LinkPlaceholderAssetComponentEntity->LinkedToAssetType_Id" } ] } } }, "ResubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequest": { "title": "ResubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ResubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "SetPlaceholderAssetComponentResourceActionRequest": { "title": "SetPlaceholderAssetComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "SetPlaceholderAssetComponentEntity->ComponentPlaceholderForAssetType_Id" } ] } } }, "UnlinkPlaceholderAssetComponentResourceActionRequest": { "title": "UnlinkPlaceholderAssetComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } } } }, "UnsubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequest": { "title": "UnsubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "UnsubscribePlaceholderAssetComponentDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangePlaceholderAssetComponentIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetComponentPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentPermissionTreeResourceActionRequest" } }, "BatchClearPlaceholderAssetComponentResourceActionRequest": { "title": "BatchClearPlaceholderAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ClearPlaceholderAssetComponentResourceActionRequest" } }, "BatchLinkPlaceholderAssetComponentResourceActionRequest": { "title": "BatchLinkPlaceholderAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/LinkPlaceholderAssetComponentResourceActionRequest" } }, "BatchSetPlaceholderAssetComponentResourceActionRequest": { "title": "BatchSetPlaceholderAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/SetPlaceholderAssetComponentResourceActionRequest" } }, "BatchUnlinkPlaceholderAssetComponentResourceActionRequest": { "title": "BatchUnlinkPlaceholderAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UnlinkPlaceholderAssetComponentResourceActionRequest" } }, "MatchUpdatePlaceholderAssetComponentResourceActionRequest": { "title": "MatchUpdatePlaceholderAssetComponentResourceActionRequest", "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": "PlaceholderAssetComponent->Quantity" } ] } } }, "GetPlaceholderAssetComponentActiveConditionResourceActionResponse": { "title": "GetPlaceholderAssetComponentActiveConditionResourceActionResponse", "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": "GetPlaceholderAssetComponentActiveConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentActiveCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentActiveCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PermissionTree_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Notes" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Description" }, "placeholderAssetComponentAssetId": { "title": "placeholderAssetComponentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_Id" }, "placeholderAssetComponentAssetNearestRegularAssetId": { "title": "placeholderAssetComponentAssetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id" }, "placeholderAssetComponentAssetNearestRegularAssetCode": { "title": "placeholderAssetComponentAssetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code" }, "placeholderAssetComponentAssetNearestRegularAssetDescription": { "title": "placeholderAssetComponentAssetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->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" } } }, "GetPlaceholderAssetComponentActiveConditionCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentActiveConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentActiveConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentActiveConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->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" } } } }, "GetPlaceholderAssetComponentActiveConditionForAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentActiveConditionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentActiveConditionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentActiveConditionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->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" } } } }, "PlaceholderAssetComponentActiveConditionChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentActiveConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentActiveConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentActiveConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentActiveConditionConditionLookupResourceActionResponse": { "title": "PlaceholderAssetComponentActiveConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentActiveConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentActiveConditionConditionLookupResourceActionResponseItemProperties", "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" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Id" }, "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" } } } }, "PlaceholderAssetComponentActiveConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentActiveConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentActiveConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentActiveConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentActiveConditionPlaceholderAssetComponentLookupResourceActionResponse": { "title": "PlaceholderAssetComponentActiveConditionPlaceholderAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentActiveConditionPlaceholderAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentActiveConditionPlaceholderAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentActiveConditionRegularAssetLookupResourceActionResponse": { "title": "PlaceholderAssetComponentActiveConditionRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentActiveConditionRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentActiveConditionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetComponentActiveConditionResourceActionRequest": { "title": "CreatePlaceholderAssetComponentActiveConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetComponentActiveConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetComponentId", "conditionId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->SequenceNumber" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->PlaceholderAssetComponent_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Condition_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetComponentActiveConditionResourceActionRequest": { "title": "UpdatePlaceholderAssetComponentActiveConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentActiveCondition->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentActiveCondition->Notes" } ] } } }, "DeletePlaceholderAssetComponentActiveConditionResourceActionRequest": { "title": "DeletePlaceholderAssetComponentActiveConditionResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetComponentActiveConditionResourceAction": { "title": "BatchGetPlaceholderAssetComponentActiveConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Component Active Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Component Active Condition entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetComponentActiveConditionResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetComponentActiveConditionResourceActionRequest": { "title": "BatchCreatePlaceholderAssetComponentActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, "BatchUpdatePlaceholderAssetComponentActiveConditionResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetComponentActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, "BatchDeletePlaceholderAssetComponentActiveConditionResourceActionRequest": { "title": "BatchDeletePlaceholderAssetComponentActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetComponentActiveConditionResourceActionRequest" } }, "ChangePlaceholderAssetComponentActiveConditionPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetComponentActiveConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentActiveCondition->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetComponentActiveConditionPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentActiveConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentActiveConditionPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetComponentAttributeResourceActionResponse": { "title": "GetPlaceholderAssetComponentAttributeResourceActionResponse", "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": "GetPlaceholderAssetComponentAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->InheritedFrom" }, "inheritedFromRegularAssetTypeAttribute": { "title": "inheritedFromRegularAssetTypeAttribute", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->InheritedFromRegularAssetTypeAttribute" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->SynchronisedWithTypeObjectUpTo" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->IsHistorical" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Unsynchronised" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->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" } } }, "GetPlaceholderAssetComponentAttributeCollectionForPlaceholderAssetComponentResourceActionResponse": { "title": "GetPlaceholderAssetComponentAttributeCollectionForPlaceholderAssetComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentAttributeCollectionForPlaceholderAssetComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentAttributeCollectionForPlaceholderAssetComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->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" } } } }, "GetPlaceholderAssetComponentAttributeCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->IsInherited" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentAttribute->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" } } } }, "PlaceholderAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "PlaceholderAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentAttributeAttributeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentAttributePlaceholderAssetComponentLookupResourceActionResponse": { "title": "PlaceholderAssetComponentAttributePlaceholderAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentAttributePlaceholderAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentAttributePlaceholderAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePlaceholderAssetComponentAttributeResourceActionRequest": { "title": "CreatePlaceholderAssetComponentAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetComponentAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetComponentId", "attributeId" ], "properties": { "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->PlaceholderAssetComponent_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "PlaceholderAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetComponentAttributeResourceActionRequest": { "title": "UpdatePlaceholderAssetComponentAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentAttribute->Notes" } ] } } }, "DeletePlaceholderAssetComponentAttributeResourceActionRequest": { "title": "DeletePlaceholderAssetComponentAttributeResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetComponentAttributeResourceAction": { "title": "BatchGetPlaceholderAssetComponentAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Component Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Component Attribute entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetComponentAttributeResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetComponentAttributeResourceActionRequest": { "title": "BatchCreatePlaceholderAssetComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetComponentAttributeResourceActionRequest" } }, "BatchUpdatePlaceholderAssetComponentAttributeResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentAttributeResourceActionRequest" } }, "BatchDeletePlaceholderAssetComponentAttributeResourceActionRequest": { "title": "BatchDeletePlaceholderAssetComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetComponentAttributeResourceActionRequest" } }, "ChangePlaceholderAssetComponentAttributeIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetComponentAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentAttribute->IsActive" } ] } } }, "ChangePlaceholderAssetComponentAttributePermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetComponentAttributePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentAttribute->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetComponentAttributeIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentAttributeIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetComponentAttributePermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentAttributePermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetComponentConditionResourceActionResponse": { "title": "GetPlaceholderAssetComponentConditionResourceActionResponse", "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": "GetPlaceholderAssetComponentConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentCondition->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentCondition->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PermissionTree_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Id" }, "conditionAdjustmentFactor": { "title": "conditionAdjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_AdjustmentFactor" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_ConditionType_Description" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->InheritedFrom" }, "inheritedFromRegularAssetTypeCondition": { "title": "inheritedFromRegularAssetTypeCondition", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->InheritedFromRegularAssetTypeCondition" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Notes" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Description" }, "placeholderAssetComponentIsActive": { "title": "placeholderAssetComponentIsActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_IsActive" }, "placeholderAssetComponentAssetId": { "title": "placeholderAssetComponentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_Id" }, "placeholderAssetComponentAssetNearestRegularAssetId": { "title": "placeholderAssetComponentAssetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id" }, "placeholderAssetComponentAssetNearestRegularAssetCode": { "title": "placeholderAssetComponentAssetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code" }, "placeholderAssetComponentAssetNearestRegularAssetDescription": { "title": "placeholderAssetComponentAssetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->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" } } }, "GetPlaceholderAssetComponentConditionCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentAssetNearestRegularAssetId": { "title": "placeholderAssetComponentAssetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Id" }, "placeholderAssetComponentAssetNearestRegularAssetCode": { "title": "placeholderAssetComponentAssetNearestRegularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Code" }, "placeholderAssetComponentAssetNearestRegularAssetDescription": { "title": "placeholderAssetComponentAssetNearestRegularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Asset_NearestRegularAsset_Description" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->State", "x-formatSpecifier": "ConditionState" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->IsActive" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->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" } } } }, "GetPlaceholderAssetComponentConditionForAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentConditionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentConditionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentConditionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_ConditionType_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->State", "x-formatSpecifier": "ConditionState" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->IsInherited" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->IsActive" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentConditionChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentConditionConditionLookupResourceActionResponse": { "title": "PlaceholderAssetComponentConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentConditionConditionLookupResourceActionResponseItemProperties", "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" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Id" }, "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" } } } }, "PlaceholderAssetComponentConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentConditionPlaceholderAssetComponentLookupResourceActionResponse": { "title": "PlaceholderAssetComponentConditionPlaceholderAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentConditionPlaceholderAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentConditionPlaceholderAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentConditionRegularAssetLookupResourceActionResponse": { "title": "PlaceholderAssetComponentConditionRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentConditionRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentConditionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetComponentConditionResourceActionRequest": { "title": "CreatePlaceholderAssetComponentConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetComponentConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetComponentId", "conditionId", "state" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->SequenceNumber" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponentCondition->PlaceholderAssetComponent_Id" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->InheritedFrom" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->Condition_Id" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->State", "x-formatSpecifier": "ConditionState" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetComponentConditionResourceActionRequest": { "title": "UpdatePlaceholderAssetComponentConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentCondition->SequenceNumber" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->AdjustmentFactor" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentCondition->Notes" } ] } } }, "DeletePlaceholderAssetComponentConditionResourceActionRequest": { "title": "DeletePlaceholderAssetComponentConditionResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetComponentConditionResourceAction": { "title": "BatchGetPlaceholderAssetComponentConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Component Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Component Condition entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetComponentConditionResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetComponentConditionResourceActionRequest": { "title": "BatchCreatePlaceholderAssetComponentConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetComponentConditionResourceActionRequest" } }, "BatchUpdatePlaceholderAssetComponentConditionResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetComponentConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentConditionResourceActionRequest" } }, "BatchDeletePlaceholderAssetComponentConditionResourceActionRequest": { "title": "BatchDeletePlaceholderAssetComponentConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetComponentConditionResourceActionRequest" } }, "ChangePlaceholderAssetComponentConditionIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetComponentConditionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentCondition->IsActive" } ] } } }, "ChangePlaceholderAssetComponentConditionPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetComponentConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentCondition->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetComponentConditionIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentConditionIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetComponentConditionPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentConditionPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetComponentDocumentResourceActionResponse": { "title": "GetPlaceholderAssetComponentDocumentResourceActionResponse", "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": "GetPlaceholderAssetComponentDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeDocument": { "title": "inheritedFromRegularAssetTypeDocument", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->InheritedFromRegularAssetTypeDocument" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->Unsynchronised" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->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" } } }, "GetPlaceholderAssetComponentDocumentCollectionForPlaceholderAssetComponentResourceActionResponse": { "title": "GetPlaceholderAssetComponentDocumentCollectionForPlaceholderAssetComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentDocumentCollectionForPlaceholderAssetComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentDocumentCollectionForPlaceholderAssetComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->InheritedFrom_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->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" } } } }, "GetPlaceholderAssetComponentDocumentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentDocument->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" } } } }, "PlaceholderAssetComponentDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentDocumentDocumentLookupResourceActionResponse": { "title": "PlaceholderAssetComponentDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentDocumentPlaceholderAssetComponentLookupResourceActionResponse": { "title": "PlaceholderAssetComponentDocumentPlaceholderAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentDocumentPlaceholderAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentDocumentPlaceholderAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetComponentDocumentResourceActionRequest": { "title": "CreatePlaceholderAssetComponentDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetComponentDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetComponentId", "documentRecordId" ], "properties": { "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->PlaceholderAssetComponent_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetComponentDocumentResourceActionRequest": { "title": "UpdatePlaceholderAssetComponentDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentDocument->Notes" } ] } } }, "DeletePlaceholderAssetComponentDocumentResourceActionRequest": { "title": "DeletePlaceholderAssetComponentDocumentResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetComponentDocumentResourceAction": { "title": "BatchGetPlaceholderAssetComponentDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Component Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Component Document entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetComponentDocumentResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetComponentDocumentResourceActionRequest": { "title": "BatchCreatePlaceholderAssetComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetComponentDocumentResourceActionRequest" } }, "BatchUpdatePlaceholderAssetComponentDocumentResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentDocumentResourceActionRequest" } }, "BatchDeletePlaceholderAssetComponentDocumentResourceActionRequest": { "title": "BatchDeletePlaceholderAssetComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetComponentDocumentResourceActionRequest" } }, "ChangePlaceholderAssetComponentDocumentIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetComponentDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentDocument->IsActive" } ] } } }, "ChangePlaceholderAssetComponentDocumentPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetComponentDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentDocument->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetComponentDocumentIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentDocumentIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetComponentDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentDocumentPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetComponentOptionValueResourceActionResponse": { "title": "GetPlaceholderAssetComponentOptionValueResourceActionResponse", "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": "GetPlaceholderAssetComponentOptionValueResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isCustom": { "title": "isCustom", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->IsCustom" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Id" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_AllowMultipleValues" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Code" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Description" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_LowerBounds" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UpperBounds" }, "optionOptionCategoryId": { "title": "optionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_OptionCategory_Id" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_OptionCategory_Description" }, "optionUnitOfMeasurementId": { "title": "optionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Id" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Description" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id" }, "regularAssetTypeOptionOptionId": { "title": "regularAssetTypeOptionOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Id" }, "regularAssetTypeOptionOptionCode": { "title": "regularAssetTypeOptionOptionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Code" }, "regularAssetTypeOptionOptionDescription": { "title": "regularAssetTypeOptionOptionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Description" }, "regularAssetTypeOptionOptionAllowMultipleValues": { "title": "regularAssetTypeOptionOptionAllowMultipleValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_AllowMultipleValues" }, "regularAssetTypeOptionOptionLowerBounds": { "title": "regularAssetTypeOptionOptionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_LowerBounds" }, "regularAssetTypeOptionOptionDataType": { "title": "regularAssetTypeOptionOptionDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_DataType", "x-formatSpecifier": "OptionDataType" }, "regularAssetTypeOptionOptionUpperBounds": { "title": "regularAssetTypeOptionOptionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UpperBounds" }, "regularAssetTypeOptionOptionOptionCategoryId": { "title": "regularAssetTypeOptionOptionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Id" }, "regularAssetTypeOptionOptionOptionCategoryCode": { "title": "regularAssetTypeOptionOptionOptionCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Code" }, "regularAssetTypeOptionOptionOptionCategoryDescription": { "title": "regularAssetTypeOptionOptionOptionCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_OptionCategory_Description" }, "regularAssetTypeOptionOptionUnitOfMeasurementId": { "title": "regularAssetTypeOptionOptionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Id" }, "regularAssetTypeOptionOptionUnitOfMeasurementCode": { "title": "regularAssetTypeOptionOptionUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Code" }, "regularAssetTypeOptionOptionUnitOfMeasurementDescription": { "title": "regularAssetTypeOptionOptionUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentOptionValue->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentOptionValue->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Notes" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->OptionValue" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_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" } } }, "GetPlaceholderAssetComponentOptionValueCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentOptionValueCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentOptionValueCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentOptionValueCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Notes" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Description" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id" }, "regularAssetTypeOptionOptionCode": { "title": "regularAssetTypeOptionOptionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Code" }, "regularAssetTypeOptionOptionDescription": { "title": "regularAssetTypeOptionOptionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Description" }, "isCustom": { "title": "isCustom", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->IsCustom" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_AllowMultipleValues" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_OptionCategory_Description" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Description" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->OptionValue" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentOptionValue->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentOptionValue->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" } } } }, "GetPlaceholderAssetComponentOptionValueForPlaceholderAssetComponentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetComponentOptionValueForPlaceholderAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetComponentOptionValueForPlaceholderAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetComponentOptionValueForPlaceholderAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->IsActive" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id" }, "placeholderAssetComponentCode": { "title": "placeholderAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Code" }, "placeholderAssetComponentDescription": { "title": "placeholderAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Description" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id" }, "regularAssetTypeOptionOptionCode": { "title": "regularAssetTypeOptionOptionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Code" }, "regularAssetTypeOptionOptionDescription": { "title": "regularAssetTypeOptionOptionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Option_Description" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Id" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_OptionCategory_Description" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UnitOfMeasurement_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_AllowMultipleValues" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Description" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->OptionValue" }, "isCustom": { "title": "isCustom", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->IsCustom" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentOptionValue->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetComponentOptionValue->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" } } } }, "PlaceholderAssetComponentOptionValueChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentOptionValueChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentOptionValueChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentOptionValueChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentOptionValueInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentOptionValueInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentOptionValueInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentOptionValueInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetComponentOptionValueOptionLookupResourceActionResponse": { "title": "PlaceholderAssetComponentOptionValueOptionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentOptionValueOptionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentOptionValueOptionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Description" }, "upperBounds": { "title": "upperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "lowerBounds": { "title": "lowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Option->DataType", "x-formatSpecifier": "OptionDataType" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Option->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Option->UnitOfMeasurement_Description" }, "optionCategoryId": { "title": "optionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->OptionCategory_Id" }, "optionCategoryCode": { "title": "optionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Code" }, "optionCategoryDescription": { "title": "optionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Description" }, "allowMultipleValues": { "title": "allowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "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" } } } }, "PlaceholderAssetComponentOptionValuePlaceholderAssetComponentLookupResourceActionResponse": { "title": "PlaceholderAssetComponentOptionValuePlaceholderAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentOptionValuePlaceholderAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentOptionValuePlaceholderAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponent->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetComponentOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponse": { "title": "PlaceholderAssetComponentOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetComponentOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetComponentOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponseItemProperties", "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" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionUnitOfMeasurementId": { "title": "optionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Id" }, "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" }, "optionOptionCategoryId": { "title": "optionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Id" }, "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" }, "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" } } } }, "CreatePlaceholderAssetComponentOptionValueResourceActionRequest": { "title": "CreatePlaceholderAssetComponentOptionValueResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetComponentOptionValueResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetComponentId", "optionValue" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->SequenceNumber" }, "placeholderAssetComponentId": { "title": "placeholderAssetComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->PlaceholderAssetComponent_Id" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->RegularAssetTypeOption_Id" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Option_Id" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetComponentOptionValue->OptionValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetComponentOptionValueResourceActionRequest": { "title": "UpdatePlaceholderAssetComponentOptionValueResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentOptionValue->SequenceNumber" }, { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->OptionValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetComponentOptionValue->Notes" } ] } } }, "DeletePlaceholderAssetComponentOptionValueResourceActionRequest": { "title": "DeletePlaceholderAssetComponentOptionValueResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetComponentOptionValueResourceAction": { "title": "BatchGetPlaceholderAssetComponentOptionValueResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Component Option Value entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Component Option Value entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetComponentOptionValueResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetComponentOptionValueResourceActionRequest": { "title": "BatchCreatePlaceholderAssetComponentOptionValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetComponentOptionValueResourceActionRequest" } }, "BatchUpdatePlaceholderAssetComponentOptionValueResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetComponentOptionValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetComponentOptionValueResourceActionRequest" } }, "BatchDeletePlaceholderAssetComponentOptionValueResourceActionRequest": { "title": "BatchDeletePlaceholderAssetComponentOptionValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetComponentOptionValueResourceActionRequest" } }, "ChangePlaceholderAssetComponentOptionValueIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetComponentOptionValueIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetComponentOptionValue->IsActive" } ] } } }, "BatchChangePlaceholderAssetComponentOptionValueIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetComponentOptionValueIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetComponentOptionValueIsActiveResourceActionRequest" } }, "GetPlaceholderAssetConditionResourceActionResponse": { "title": "GetPlaceholderAssetConditionResourceActionResponse", "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": "GetPlaceholderAssetConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetCondition->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetCondition->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PermissionTree_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Condition_ConditionType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_LastConfirmedOn" }, "inheritedFromConditionId": { "title": "inheritedFromConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Condition_Id" }, "inheritedFromConditionCode": { "title": "inheritedFromConditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Condition_Code" }, "inheritedFromConditionDescription": { "title": "inheritedFromConditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Condition_Description" }, "inheritedFromConditionConditionTypeId": { "title": "inheritedFromConditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Id" }, "inheritedFromConditionConditionTypeCode": { "title": "inheritedFromConditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Code" }, "inheritedFromConditionConditionTypeDescription": { "title": "inheritedFromConditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Condition_ConditionType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Notes" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Description" }, "placeholderAssetNearestRegularAssetId": { "title": "placeholderAssetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Id" }, "placeholderAssetNearestRegularAssetCode": { "title": "placeholderAssetNearestRegularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Code" }, "placeholderAssetNearestRegularAssetDescription": { "title": "placeholderAssetNearestRegularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_NearestRegularAsset_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->RecordType", "x-formatSpecifier": "AssetRecordType" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->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" } } }, "GetPlaceholderAssetConditionCollectionResourceActionResponse": { "title": "GetPlaceholderAssetConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->State", "x-formatSpecifier": "ConditionState" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->IsActive" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->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" } } } }, "GetPlaceholderAssetConditionForAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetConditionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetConditionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetConditionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_ConditionType_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->State", "x-formatSpecifier": "ConditionState" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->IsInherited" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->IsActive" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConditionChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetConditionConditionLookupResourceActionResponse": { "title": "PlaceholderAssetConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConditionConditionLookupResourceActionResponseItemProperties", "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" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Id" }, "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" } } } }, "PlaceholderAssetConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetConditionPlaceholderAssetLookupResourceActionResponse": { "title": "PlaceholderAssetConditionPlaceholderAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConditionPlaceholderAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConditionPlaceholderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConditionRegularAssetLookupResourceActionResponse": { "title": "PlaceholderAssetConditionRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConditionRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConditionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetConditionResourceActionRequest": { "title": "CreatePlaceholderAssetConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetId", "conditionId", "state" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->SequenceNumber" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetCondition->PlaceholderAsset_Id" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->InheritedFrom_Id" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->Condition_Id" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->State", "x-formatSpecifier": "ConditionState" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetConditionResourceActionRequest": { "title": "UpdatePlaceholderAssetConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetCondition->SequenceNumber" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->AdjustmentFactor" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetCondition->Notes" } ] } } }, "DeletePlaceholderAssetConditionResourceActionRequest": { "title": "DeletePlaceholderAssetConditionResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetConditionResourceAction": { "title": "BatchGetPlaceholderAssetConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Condition entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetConditionResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetConditionResourceActionRequest": { "title": "BatchCreatePlaceholderAssetConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetConditionResourceActionRequest" } }, "BatchUpdatePlaceholderAssetConditionResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetConditionResourceActionRequest" } }, "BatchDeletePlaceholderAssetConditionResourceActionRequest": { "title": "BatchDeletePlaceholderAssetConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetConditionResourceActionRequest" } }, "ChangePlaceholderAssetConditionIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetConditionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetCondition->IsActive" } ] } } }, "ChangePlaceholderAssetConditionPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetCondition->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetConditionIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetConditionIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetConditionPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetConditionPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetConsumptionResourceActionResponse": { "title": "GetPlaceholderAssetConsumptionResourceActionResponse", "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": "GetPlaceholderAssetConsumptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->PermissionTree_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->ConsumedOn" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Currency_Description" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRate_Id" }, "currencyRateUserSuppliedConversionRate": { "title": "currencyRateUserSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRate_UserSuppliedConversionRate" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRate_AppliedConversionRate" }, "currencyRateValue": { "title": "currencyRateValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRateValue" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Location_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Id", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Description" }, "meterUnitOfMeasurementId": { "title": "meterUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Id" }, "meterUnitOfMeasurementCode": { "title": "meterUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Code" }, "meterUnitOfMeasurementDescription": { "title": "meterUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Meter_UnitOfMeasurement_Description" }, "meterReadingId": { "title": "meterReadingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->MeterReading_Id" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingOn", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingValue ne NULL" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingValue", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Site_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->SiteCurrency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->SiteCurrency_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_AlternativeDescription" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_MaterialMaster_Description" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Warehouse_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Description" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->TotalCostInSiteCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitPrice" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostingCollectionForPlaceholderAssetConsumptionResourceActionResponse": { "title": "GetCostingCollectionForPlaceholderAssetConsumptionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostingCollectionForPlaceholderAssetConsumptionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostingCollectionForPlaceholderAssetConsumptionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Description" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "totalCostInBaseCurrency": { "title": "totalCostInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInBaseCurrency" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetPlaceholderAssetConsumptionCollectionResourceActionResponse": { "title": "GetPlaceholderAssetConsumptionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetConsumptionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetConsumptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->ConsumedOn" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_AlternativeDescription" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Quantity" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Site_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Description" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingValue", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingOn", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->SiteCurrency_Code" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRate_Id" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRate_AppliedConversionRate" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitPrice" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->TotalCostInSiteCurrency" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetPlaceholderAssetConsumptionForAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetConsumptionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetConsumptionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetConsumptionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->ConsumedOn" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_AlternativeDescription" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Quantity" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Site_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Description" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingValue", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingOn", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->SiteCurrency_Code" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRate_Id" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CurrencyRate_AppliedConversionRate" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitPrice" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->TotalCostInSiteCurrency" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetConsumptionConsumableLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionConsumableLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionConsumableLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionConsumableLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Consumable->UnitPrice" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionCostCentreLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionCostElementLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetConsumptionFinancialYearPeriodLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionFinancialYearPeriodLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionFinancialYearPeriodLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionGeneralLedgerLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetConsumptionMeterLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionMeterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionPlaceholderAssetLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionPlaceholderAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionPlaceholderAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionPlaceholderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Site_Id" }, "siteFinancialYearPeriodId": { "title": "siteFinancialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Site_FinancialYearPeriod_Id" }, "siteFinancialYearPeriodCode": { "title": "siteFinancialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_FinancialYearPeriod_Code" }, "siteFinancialYearPeriodDescription": { "title": "siteFinancialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_FinancialYearPeriod_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Site_Currency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Currency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Currency_Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->CostCentre_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->GeneralLedger_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Location_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionResourceLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionResourceLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetConsumptionStockItemLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionStockItemLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionStockItemLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionSupplierLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->Site_Currency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Currency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Currency_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionUnitOfMeasurementLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetConsumptionCurrencyLookupResourceActionResponse": { "title": "PlaceholderAssetConsumptionCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetConsumptionCurrencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetConsumptionCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetConsumptionResourceActionRequest": { "title": "CreatePlaceholderAssetConsumptionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetConsumptionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetId", "consumableId", "quantity" ], "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PlaceholderAsset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->PermissionTree_Id", "x-systemGenerated": true }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Id" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Id" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->ConsumedOn", "x-systemGenerated": true }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Id", "x-systemGenerated": true }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetConsumption->UnitPrice", "x-systemGenerated": true }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Quantity" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Id", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingValue", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingOn", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Id" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Currency_Id", "x-systemGenerated": true }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Id", "x-systemGenerated": true }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetConsumptionResourceActionRequest": { "title": "UpdatePlaceholderAssetConsumptionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Resource_Id" }, { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Consumable_Id" }, { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->ConsumedOn" }, { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->StockItem_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->UnitOfMeasurement_Id" }, { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Quantity" }, { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Meter_Id", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, { "title": "meterReadingValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingValue", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingOn ne NULL" }, { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetConsumption->MeterReadingOn", "x-NullExpression": "PlaceholderAssetConsumption->MeterReadingValue ne NULL" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Supplier_Id" }, { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->Currency_Id" }, { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetConsumption->UnitPrice" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->CostElement_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->GeneralLedger_Id" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetConsumption->FinancialYearPeriod_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetConsumption->Notes" } ] } } }, "DeletePlaceholderAssetConsumptionResourceActionRequest": { "title": "DeletePlaceholderAssetConsumptionResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetConsumptionResourceAction": { "title": "BatchGetPlaceholderAssetConsumptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Consumption entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Consumption entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetConsumptionResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetConsumptionResourceActionRequest": { "title": "BatchCreatePlaceholderAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetConsumptionResourceActionRequest" } }, "BatchUpdatePlaceholderAssetConsumptionResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetConsumptionResourceActionRequest" } }, "BatchDeletePlaceholderAssetConsumptionResourceActionRequest": { "title": "BatchDeletePlaceholderAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetConsumptionResourceActionRequest" } }, "ChangePlaceholderAssetConsumptionIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetConsumptionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetConsumption->IsActive" } ] } } }, "ChangePlaceholderAssetConsumptionPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetConsumptionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetConsumption->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetConsumptionIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetConsumptionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetConsumptionIsActiveResourceActionRequest" } }, "GetPlaceholderAssetDocumentResourceActionResponse": { "title": "GetPlaceholderAssetDocumentResourceActionResponse", "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": "GetPlaceholderAssetDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->InheritedFrom_Id" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->PlaceholderAsset_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->Unsynchronised" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->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" } } }, "GetPlaceholderAssetDocumentCollectionForPlaceholderAssetResourceActionResponse": { "title": "GetPlaceholderAssetDocumentCollectionForPlaceholderAssetResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetDocumentCollectionForPlaceholderAssetResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetDocumentCollectionForPlaceholderAssetResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->InheritedFrom_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->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" } } } }, "GetPlaceholderAssetDocumentCollectionResourceActionResponse": { "title": "GetPlaceholderAssetDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->PlaceholderAsset_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetDocument->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" } } } }, "PlaceholderAssetDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetDocumentDocumentLookupResourceActionResponse": { "title": "PlaceholderAssetDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetDocumentPlaceholderAssetLookupResourceActionResponse": { "title": "PlaceholderAssetDocumentPlaceholderAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetDocumentPlaceholderAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetDocumentPlaceholderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetDocumentResourceActionRequest": { "title": "CreatePlaceholderAssetDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetId", "documentRecordId" ], "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->PlaceholderAsset_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetDocumentResourceActionRequest": { "title": "UpdatePlaceholderAssetDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetDocument->Notes" } ] } } }, "DeletePlaceholderAssetDocumentResourceActionRequest": { "title": "DeletePlaceholderAssetDocumentResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetDocumentResourceAction": { "title": "BatchGetPlaceholderAssetDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Document entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetDocumentResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetDocumentResourceActionRequest": { "title": "BatchCreatePlaceholderAssetDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetDocumentResourceActionRequest" } }, "BatchUpdatePlaceholderAssetDocumentResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetDocumentResourceActionRequest" } }, "BatchDeletePlaceholderAssetDocumentResourceActionRequest": { "title": "BatchDeletePlaceholderAssetDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetDocumentResourceActionRequest" } }, "ChangePlaceholderAssetDocumentIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetDocument->IsActive" } ] } } }, "ChangePlaceholderAssetDocumentPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetDocument->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetDocumentIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetDocumentIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetDocumentPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetMeterResourceActionResponse": { "title": "GetPlaceholderAssetMeterResourceActionResponse", "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": "GetPlaceholderAssetMeterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetMeter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetMeter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->PermissionTree_Description" }, "assetMeterType": { "title": "assetMeterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->AssetMeterType", "x-formatSpecifier": "EntityType" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->IsMainMeter" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->Meter_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->Notes" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->PlaceholderAsset_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->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" } } }, "GetPlaceholderAssetMeterCollectionResourceActionResponse": { "title": "GetPlaceholderAssetMeterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetMeterCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->PlaceholderAsset_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->Meter_Description" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->IsMainMeter" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->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" } } } }, "GetPlaceholderAssetMeterForAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetMeterForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetMeterForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetMeterForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->Meter_Description" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->IsMainMeter" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->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" } } } }, "PlaceholderAssetMeterAssetLookupResourceActionResponse": { "title": "PlaceholderAssetMeterAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetMeterAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetMeterAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetMeterChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetMeterChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetMeterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetMeterChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetMeterInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetMeterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetMeterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetMeterInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetMeterMeterLookupResourceActionResponse": { "title": "PlaceholderAssetMeterMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetMeterMeterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetMeterMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetMeterResourceActionRequest": { "title": "CreatePlaceholderAssetMeterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetMeterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetId", "meterId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->PermissionTree_Id", "x-systemGenerated": true }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->PlaceholderAsset_Id" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->Meter_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetMeterResourceActionRequest": { "title": "UpdatePlaceholderAssetMeterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetMeter->SequenceNumber" }, { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetMeter->IsMainMeter" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetMeter->Notes" } ] } } }, "DeletePlaceholderAssetMeterResourceActionRequest": { "title": "DeletePlaceholderAssetMeterResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetMeterResourceAction": { "title": "BatchGetPlaceholderAssetMeterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Meter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Meter entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetMeterResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetMeterResourceActionRequest": { "title": "BatchCreatePlaceholderAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetMeterResourceActionRequest" } }, "BatchUpdatePlaceholderAssetMeterResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetMeterResourceActionRequest" } }, "BatchDeletePlaceholderAssetMeterResourceActionRequest": { "title": "BatchDeletePlaceholderAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetMeterResourceActionRequest" } }, "ChangePlaceholderAssetMeterIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetMeterIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetMeter->IsActive" } ] } } }, "SetMainPlaceholderAssetMeterStatusResourceActionRequest": { "title": "SetMainPlaceholderAssetMeterStatusResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "SetPlaceholderAssetMainMeterStatus->IsMainMeter" } ] } } }, "BatchChangePlaceholderAssetMeterIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetMeterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetMeterIsActiveResourceActionRequest" } }, "GetPlaceholderAssetResponsibilityResourceActionResponse": { "title": "GetPlaceholderAssetResponsibilityResourceActionResponse", "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": "GetPlaceholderAssetResponsibilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetResponsibility->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetResponsibility->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetResponsibility->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetResponsibility->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Notes" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->PlaceholderAsset_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->RecordType", "x-formatSpecifier": "AssetRecordType" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_Code" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_ContactDetailLastName" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->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" } } }, "GetPlaceholderAssetResponsibilityCollectionResourceActionResponse": { "title": "GetPlaceholderAssetResponsibilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetResponsibilityCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetResponsibilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->IsActive" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->PlaceholderAsset_Code" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Trade_Code" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Code" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_Code" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetPlaceholderAssetResponsibilityForPlaceholderAssetCollectionResourceActionResponse": { "title": "GetPlaceholderAssetResponsibilityForPlaceholderAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetResponsibilityForPlaceholderAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetResponsibilityForPlaceholderAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Trade_Code" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->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" } } } }, "PlaceholderAssetResponsibilityChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetResponsibilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetResponsibilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetResponsibilityChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetResponsibilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetResponsibilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetResponsibilityPlaceholderAssetLookupResourceActionResponse": { "title": "PlaceholderAssetResponsibilityPlaceholderAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetResponsibilityPlaceholderAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetResponsibilityPlaceholderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "PlaceholderAssetResponsibilityResourceLookupResourceActionResponse": { "title": "PlaceholderAssetResponsibilityResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetResponsibilityResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetResponsibilityResourceLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetResponsibilitySectionLookupResourceActionResponse": { "title": "PlaceholderAssetResponsibilitySectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetResponsibilitySectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetResponsibilitySectionLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetResponsibilityTradeLookupResourceActionResponse": { "title": "PlaceholderAssetResponsibilityTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetResponsibilityTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetResponsibilityTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePlaceholderAssetResponsibilityResourceActionRequest": { "title": "CreatePlaceholderAssetResponsibilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetResponsibilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->PermissionTree_Id", "x-systemGenerated": true }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->PlaceholderAsset_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Trade_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetResponsibilityResourceActionRequest": { "title": "UpdatePlaceholderAssetResponsibilityResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetResponsibility->SequenceNumber" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetResponsibility->Resource_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetResponsibility->Notes" } ] } } }, "DeletePlaceholderAssetResponsibilityResourceActionRequest": { "title": "DeletePlaceholderAssetResponsibilityResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetResponsibilityResourceAction": { "title": "BatchGetPlaceholderAssetResponsibilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Responsibility entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Responsibility entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetResponsibilityResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetResponsibilityResourceActionRequest": { "title": "BatchCreatePlaceholderAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetResponsibilityResourceActionRequest" } }, "BatchUpdatePlaceholderAssetResponsibilityResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetResponsibilityResourceActionRequest" } }, "BatchDeletePlaceholderAssetResponsibilityResourceActionRequest": { "title": "BatchDeletePlaceholderAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetResponsibilityResourceActionRequest" } }, "ChangePlaceholderAssetResponsibilityIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetResponsibilityIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetResponsibility->IsActive" } ] } } }, "ChangePlaceholderAssetResponsibilityPermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetResponsibilityPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetResponsibility->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetResponsibilityIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetResponsibilityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetResponsibilityIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetResponsibilityPermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetResponsibilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetResponsibilityPermissionTreeResourceActionRequest" } }, "GetPlaceholderAssetSpareResourceActionResponse": { "title": "GetPlaceholderAssetSpareResourceActionResponse", "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": "GetPlaceholderAssetSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetSpare->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetSpare->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PlaceholderAssetSpare->InheritedFrom_LastConfirmedOn" }, "inheritedFromMaterialMasterId": { "title": "inheritedFromMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Id" }, "inheritedFromMaterialMasterCode": { "title": "inheritedFromMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Code" }, "inheritedFromMaterialMasterDescription": { "title": "inheritedFromMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->InheritedFrom_MaterialMaster_Description" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsEmergency" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->Notes" }, "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->PlaceholderAsset_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "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" } } }, "GetPlaceholderAssetSpareCollectionResourceActionResponse": { "title": "GetPlaceholderAssetSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPlaceholderAssetSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPlaceholderAssetSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->PlaceholderAsset_Id" }, "placeholderAssetCode": { "title": "placeholderAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->PlaceholderAsset_Code" }, "placeholderAssetDescription": { "title": "placeholderAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->PlaceholderAsset_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->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" } } } }, "GetSpareForPlaceholderAssetCollectionResourceActionResponse": { "title": "GetSpareForPlaceholderAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForPlaceholderAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForPlaceholderAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->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" } } } }, "PlaceholderAssetSpareChangePermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "PlaceholderAssetSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetSpareMaterialMasterLookupResourceActionResponse": { "title": "PlaceholderAssetSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "PlaceholderAssetSparePlaceholderAssetLookupResourceActionResponse": { "title": "PlaceholderAssetSparePlaceholderAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "PlaceholderAssetSparePlaceholderAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "PlaceholderAssetSparePlaceholderAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PlaceholderAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePlaceholderAssetSpareResourceActionRequest": { "title": "CreatePlaceholderAssetSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePlaceholderAssetSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "placeholderAssetId", "materialMasterId", "isCritical", "isEmergency" ], "properties": { "placeholderAssetId": { "title": "placeholderAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "PlaceholderAssetSpare->PlaceholderAsset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->PermissionTree_Id", "x-systemGenerated": true }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->SequenceNumber" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsEmergency" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePlaceholderAssetSpareResourceActionRequest": { "title": "UpdatePlaceholderAssetSpareResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetSpare->SequenceNumber" }, { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsCritical" }, { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->IsEmergency" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PlaceholderAssetSpare->Notes" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PlaceholderAssetSpare->MaterialMaster_Id" } ] } } }, "DeletePlaceholderAssetSpareResourceActionRequest": { "title": "DeletePlaceholderAssetSpareResourceActionRequest", "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 } } }, "BatchGetPlaceholderAssetSpareResourceAction": { "title": "BatchGetPlaceholderAssetSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Placeholder Asset Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Placeholder Asset Spare entities", "items": { "$ref": "#/definitions/GetPlaceholderAssetSpareResourceActionResponse" } }, "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" } } }, "BatchCreatePlaceholderAssetSpareResourceActionRequest": { "title": "BatchCreatePlaceholderAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePlaceholderAssetSpareResourceActionRequest" } }, "BatchUpdatePlaceholderAssetSpareResourceActionRequest": { "title": "BatchUpdatePlaceholderAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePlaceholderAssetSpareResourceActionRequest" } }, "BatchDeletePlaceholderAssetSpareResourceActionRequest": { "title": "BatchDeletePlaceholderAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePlaceholderAssetSpareResourceActionRequest" } }, "ChangePlaceholderAssetSpareIsActiveResourceActionRequest": { "title": "ChangePlaceholderAssetSpareIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetSpare->IsActive" } ] } } }, "ChangePlaceholderAssetSparePermissionTreeResourceActionRequest": { "title": "ChangePlaceholderAssetSparePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "PlaceholderAssetSpare->PermissionTree_Id" } ] } } }, "BatchChangePlaceholderAssetSpareIsActiveResourceActionRequest": { "title": "BatchChangePlaceholderAssetSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetSpareIsActiveResourceActionRequest" } }, "BatchChangePlaceholderAssetSparePermissionTreeResourceActionRequest": { "title": "BatchChangePlaceholderAssetSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePlaceholderAssetSparePermissionTreeResourceActionRequest" } }, "GetRegularAssetResourceActionResponse": { "title": "GetRegularAssetResourceActionResponse", "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": "GetRegularAssetResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->Calendar_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Calendar_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->CostCentre_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAsset->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->GeneralLedger_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->LastConfirmedOn" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Description" }, "nearestRegularAssetId": { "title": "nearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->NearestRegularAsset_Id" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->ParentAsset_Id" }, "parentAssetCode": { "title": "parentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ParentAsset_Code" }, "parentAssetDescription": { "title": "parentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ParentAsset_Description" }, "parentAssetRecordType": { "title": "parentAssetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAsset->ParentAsset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAsset->SequenceNumber" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Site_Description" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->Unsynchronised" }, "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAsset->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->RulesLastEvaluatedOn" }, "unsubscribed": { "title": "unsubscribed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->Unsubscribed" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "RegularAsset->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicUnitOfMeasurement_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->PermissionTree_Description" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionStatus_Id" }, "acquisitionStatusCode": { "title": "acquisitionStatusCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionStatus_Code" }, "acquisitionStatusDescription": { "title": "acquisitionStatusDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionStatus_Description" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionType_Id" }, "acquisitionTypeCode": { "title": "acquisitionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionType_Code" }, "acquisitionTypeDescription": { "title": "acquisitionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionType_Description" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetImportance_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetType_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Barcode" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->BudgetedReplacementAmount" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->CommissionedOn" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Description" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->CurrentValue" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->DateOfCurrentValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->DowntimeCostPerHour" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->ExpectedReplacementDate" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->InheritedFrom_LastConfirmedOn" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->InsuredValue" }, "isForScheduledWorkOnly": { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsForScheduledWorkOnly" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsMsi" }, "isOptionsUsed": { "title": "isOptionsUsed", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsOptionsUsed" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsPermitRequired" }, "isRunning": { "title": "isRunning", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsRunning" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Notes" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->PurchaseAmount" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->QRCode" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAsset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->ReplacementAsset_Id" }, "replacementAssetCode": { "title": "replacementAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ReplacementAsset_Code" }, "replacementAssetDescription": { "title": "replacementAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ReplacementAsset_Description" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->SerialNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Supplier_Description" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->TaskRollUpPoint_Id", "x-NullExpression": "RegularAsset->IsMsi eq false" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->TaskRollUpPoint_Description" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAsset->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAsset->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } }, "GetRegularAssetCollectionResourceActionResponse": { "title": "GetRegularAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsActive" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Description" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->ParentAsset_Id" }, "parentAssetCode": { "title": "parentAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ParentAsset_Code" }, "parentAssetDescription": { "title": "parentAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->ParentAsset_Description" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->QRCode" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->SerialNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAsset->SequenceNumber" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Barcode" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAsset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Location_Description" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AssetImportance_Description" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Calendar_Id" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Calendar_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Description" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Description" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->PurchaseAmount" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->CurrentValue" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Supplier_Description" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionType_Id" }, "acquisitionTypeCode": { "title": "acquisitionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AcquisitionType_Code" }, "acquisitionTypeDescription": { "title": "acquisitionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AcquisitionType_Description" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionStatus_Id" }, "acquisitionStatusCode": { "title": "acquisitionStatusCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AcquisitionStatus_Code" }, "acquisitionStatusDescription": { "title": "acquisitionStatusDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AcquisitionStatus_Description" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->ReplacementAsset_Id" }, "replacementAssetCode": { "title": "replacementAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->ReplacementAsset_Code" }, "replacementAssetDescription": { "title": "replacementAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->ReplacementAsset_Description" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->BudgetedReplacementAmount" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->DowntimeCostPerHour" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->InsuredValue" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->CommissionedOn" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->ExpectedReplacementDate" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->DateOfCurrentValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Notes" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->PermissionTree_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->ModifiedOn" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->AssetType_Description" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->RulesLastEvaluatedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAsset->SynchronisedWithTypeObjectUpTo" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsInherited" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsMsi" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->InheritedFrom_Id" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->RuleEvaluationPassed" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAsset->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->Unsynchronised" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAsset->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" } } } }, "RegularAssetAcquisitionStatusLookupResourceActionResponse": { "title": "RegularAssetAcquisitionStatusLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAcquisitionStatusLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAcquisitionStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionStatus->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionStatus->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetAcquisitionTypeLookupResourceActionResponse": { "title": "RegularAssetAcquisitionTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAcquisitionTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAcquisitionTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AcquisitionType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetAssetParentLookupResourceActionResponse": { "title": "RegularAssetAssetParentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAssetParentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAssetParentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Asset->Site_Id" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetCalendarLookupResourceActionResponse": { "title": "RegularAssetCalendarLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetCalendarLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetCalendarLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetCommissioningWorkOrderLookupResourceActionResponse": { "title": "RegularAssetCommissioningWorkOrderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetCommissioningWorkOrderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetCommissioningWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetCostCentreLookupResourceActionResponse": { "title": "RegularAssetCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetGeneralLedgerLookupResourceActionResponse": { "title": "RegularAssetGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetGeographicDataAssetEntityLookupResourceActionResponse": { "title": "RegularAssetGeographicDataAssetEntityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetGeographicDataAssetEntityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetGeographicDataAssetEntityLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Asset->Site_Code" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "Asset->GeographicLocation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetImportanceLookupResourceActionResponse": { "title": "RegularAssetImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetImportanceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetLocationLookupResourceActionResponse": { "title": "RegularAssetLocationLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetLocationLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetLocationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetRegularAssetTypeLookupResourceActionResponse": { "title": "RegularAssetRegularAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetRegularAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetRegularAssetTypeLookupResourceActionResponseItemProperties", "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" }, "canSelectOnAsset": { "title": "canSelectOnAsset", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetType->CanSelectOnAsset" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetReplacementAssetLookupResourceActionResponse": { "title": "RegularAssetReplacementAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetReplacementAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetReplacementAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetSiteLookupResourceActionResponse": { "title": "RegularAssetSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetSiteLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" }, "isVirtual": { "title": "isVirtual", "type": "boolean", "x-nullable": false, "x-propertyPath": "Site->IsVirtual" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetSupplierLookupResourceActionResponse": { "title": "RegularAssetSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskRollUpPointLookupResourceActionResponse": { "title": "RegularAssetTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetResourceActionRequest": { "title": "CreateRegularAssetResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "description", "isMsi", "parentAssetId", "isForScheduledWorkOnly", "isRunning" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAsset->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, "isMsi": { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsMsi" }, "parentAssetId": { "title": "parentAssetId", "type": "integer", "format": "int64", "minimum": 1.0, "x-nullable": false, "x-propertyPath": "RegularAsset->ParentAsset_Id" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->QRCode" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->SerialNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAsset->SequenceNumber" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Barcode" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Id" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetImportance_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->TaskRollUpPoint_Id", "x-NullExpression": "RegularAsset->IsMsi eq false" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Id" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->Calendar_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, "purchaseAmount": { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->PurchaseAmount" }, "currentValue": { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->CurrentValue" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Supplier_Id" }, "acquisitionTypeId": { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionType_Id" }, "acquisitionStatusId": { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionStatus_Id" }, "replacementAssetId": { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->ReplacementAsset_Id" }, "budgetedReplacementAmount": { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->BudgetedReplacementAmount" }, "downtimeCostPerHour": { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->DowntimeCostPerHour" }, "insuredValue": { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->InsuredValue" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->CommissionedOn" }, "expectedReplacementDate": { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->ExpectedReplacementDate" }, "dateOfCurrentValue": { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->DateOfCurrentValue" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetType_Id" }, "isForScheduledWorkOnly": { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsForScheduledWorkOnly" }, "isPermitRequired": { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsPermitRequired" }, "isRunning": { "title": "isRunning", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsRunning" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Notes" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "RegularAsset->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetResourceActionRequest": { "title": "UpdateRegularAssetResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAsset->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetType_Id" }, { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->QRCode" }, { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->RFId" }, { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->SerialNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAsset->SequenceNumber" }, { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Barcode" }, { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsMsi" }, { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsForScheduledWorkOnly" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsPermitRequired" }, { "title": "isRunning", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsRunning" }, { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->TaskRollUpPoint_Id", "x-NullExpression": "RegularAsset->IsMsi eq false" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Id" }, { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->Calendar_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->PurchaseAmount" }, { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->CurrentValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Supplier_Id" }, { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionType_Id" }, { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionStatus_Id" }, { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->ReplacementAsset_Id" }, { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->BudgetedReplacementAmount" }, { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->DowntimeCostPerHour" }, { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->InsuredValue" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->CommissionedOn" }, { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->ExpectedReplacementDate" }, { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->DateOfCurrentValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Notes" }, { "title": "geographicLocation", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAsset->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->GeographicReferenceEntityId" } ] } } }, "DeleteRegularAssetResourceActionRequest": { "title": "DeleteRegularAssetResourceActionRequest", "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 } } }, "BatchGetRegularAssetResourceAction": { "title": "BatchGetRegularAssetResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset entities", "items": { "$ref": "#/definitions/GetRegularAssetResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetResourceActionRequest": { "title": "BatchCreateRegularAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetResourceActionRequest" } }, "BatchUpdateAssetResourceActionRequest": { "title": "BatchUpdateAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetResourceActionRequest" } }, "BatchDeleteRegularAssetResourceActionRequest": { "title": "BatchDeleteRegularAssetResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetResourceActionRequest" } }, "ChangeRegularAssetAssetTypeResourceActionRequest": { "title": "ChangeRegularAssetAssetTypeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } } } }, "ChangeRegularAssetIsActiveResourceActionRequest": { "title": "ChangeRegularAssetIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAsset->IsActive" } ] } } }, "ChangeRegularAssetPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAsset->PermissionTree_Id" } ] } } }, "MoveRegularAssetResourceActionRequest": { "title": "MoveRegularAssetResourceActionRequest", "type": "object", "properties": { "properties": { "title": "MoveRegularAssetResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "sourceId", "targetId" ], "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" }, "inheritParentCostCentre": { "title": "inheritParentCostCentre", "type": "boolean", "x-nullable": true, "x-propertyPath": "MoveEntity->InheritParentCostCentre" }, "inheritParentLocation": { "title": "inheritParentLocation", "type": "boolean", "x-nullable": true, "x-propertyPath": "MoveEntity->InheritParentLocation" }, "synchroniseMetersWithAssetSiteAndPermissionTree": { "title": "synchroniseMetersWithAssetSiteAndPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "MoveEntity->SynchroniseMetersWithAssetSiteAndPermissionTree" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeRegularAssetSiteResourceActionRequest": { "title": "ChangeRegularAssetSiteResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetSiteChange->SiteId" } ] } } }, "ResubscribeRegularAssetDevelopmentStatusResourceActionRequest": { "title": "ResubscribeRegularAssetDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ResubscribeRegularAssetDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UnsubscribeRegularAssetDevelopmentStatusResourceActionRequest": { "title": "UnsubscribeRegularAssetDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "UnsubscribeRegularAssetDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeRegularAssetAssetTypeResourceActionRequest": { "title": "BatchChangeRegularAssetAssetTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetAssetTypeResourceActionRequest" } }, "BatchChangeRegularAssetIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetPermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetResourceActionRequest": { "title": "MatchUpdateRegularAssetResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->QRCode" }, { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->RFId" }, { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->SerialNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAsset->SequenceNumber" }, { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Barcode" }, { "title": "isPermitRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAsset->IsPermitRequired" }, { "title": "isRunning", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsRunning" }, { "title": "isMsi", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsMsi" }, { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Id" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetImportance_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->TaskRollUpPoint_Id", "x-NullExpression": "RegularAsset->IsMsi eq false" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CommissioningWorkOrder_Id" }, { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->Calendar_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Id", "x-NullExpression": "RegularAsset->IsMsi eq true" }, { "title": "purchaseAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->PurchaseAmount" }, { "title": "currentValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->CurrentValue" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Supplier_Id" }, { "title": "acquisitionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionType_Id" }, { "title": "acquisitionStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AcquisitionStatus_Id" }, { "title": "replacementAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->ReplacementAsset_Id" }, { "title": "budgetedReplacementAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->BudgetedReplacementAmount" }, { "title": "downtimeCostPerHour", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->DowntimeCostPerHour" }, { "title": "insuredValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAsset->InsuredValue" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->CommissionedOn" }, { "title": "expectedReplacementDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->ExpectedReplacementDate" }, { "title": "dateOfCurrentValue", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAsset->DateOfCurrentValue" }, { "title": "isForScheduledWorkOnly", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAsset->IsForScheduledWorkOnly" }, { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->AssetType_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAsset->Notes" } ] } } }, "GetRegularAssetActiveConditionResourceActionResponse": { "title": "GetRegularAssetActiveConditionResourceActionResponse", "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": "GetRegularAssetActiveConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetActiveCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetActiveCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->PermissionTree_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Condition_ConditionType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->RecordType", "x-formatSpecifier": "AssetRecordType" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->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" } } }, "GetRegularAssetActiveConditionCollectionResourceActionResponse": { "title": "GetRegularAssetActiveConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetActiveConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetActiveConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->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" } } } }, "GetRegularAssetActiveConditionForAssetCollectionResourceActionResponse": { "title": "GetRegularAssetActiveConditionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetActiveConditionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetActiveConditionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->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" } } } }, "RegularAssetActiveConditionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetActiveConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetActiveConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetActiveConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetActiveConditionConditionLookupResourceActionResponse": { "title": "RegularAssetActiveConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetActiveConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetActiveConditionConditionLookupResourceActionResponseItemProperties", "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" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Id" }, "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" } } } }, "RegularAssetActiveConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetActiveConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetActiveConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetActiveConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetActiveConditionRegularAssetLookupResourceActionResponse": { "title": "RegularAssetActiveConditionRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetActiveConditionRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetActiveConditionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetActiveConditionResourceActionRequest": { "title": "CreateRegularAssetActiveConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetActiveConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "conditionId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->SequenceNumber" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetActiveCondition->RegularAsset_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetActiveCondition->Condition_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetActiveConditionResourceActionRequest": { "title": "UpdateRegularAssetActiveConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetActiveCondition->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetActiveCondition->Notes" } ] } } }, "DeleteRegularAssetActiveConditionResourceActionRequest": { "title": "DeleteRegularAssetActiveConditionResourceActionRequest", "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 } } }, "BatchGetRegularAssetActiveConditionResourceAction": { "title": "BatchGetRegularAssetActiveConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Active Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Active Condition entities", "items": { "$ref": "#/definitions/GetRegularAssetActiveConditionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetActiveConditionResourceActionRequest": { "title": "BatchCreateRegularAssetActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetActiveConditionResourceActionRequest" } }, "BatchUpdateRegularAssetActiveConditionResourceActionRequest": { "title": "BatchUpdateRegularAssetActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetActiveConditionResourceActionRequest" } }, "BatchDeleteRegularAssetActiveConditionResourceActionRequest": { "title": "BatchDeleteRegularAssetActiveConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetActiveConditionResourceActionRequest" } }, "ChangeRegularAssetActiveConditionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetActiveConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetActiveCondition->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetActiveConditionPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetActiveConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetActiveConditionPermissionTreeResourceActionRequest" } }, "GetRegularAssetAttributeResourceActionResponse": { "title": "GetRegularAssetAttributeResourceActionResponse", "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": "GetRegularAssetAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->InheritedFrom_Id" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->RegularAsset_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->SynchronisedWithTypeObjectUpTo" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->IsHistorical" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Unsynchronised" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->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" } } }, "GetRegularAssetAttributeCollectionForRegularAssetResourceActionResponse": { "title": "GetRegularAssetAttributeCollectionForRegularAssetResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetAttributeCollectionForRegularAssetResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetAttributeCollectionForRegularAssetResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetAttributeCollectionResourceActionResponse": { "title": "GetRegularAssetAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->RegularAsset_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RegularAssetAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetAttributeAttributeLookupResourceActionResponse": { "title": "RegularAssetAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetAttributeRegularAssetLookupResourceActionResponse": { "title": "RegularAssetAttributeRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetAttributeRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetAttributeRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetAttributeResourceActionRequest": { "title": "CreateRegularAssetAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "attributeId" ], "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->RegularAsset_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetAttributeResourceActionRequest": { "title": "UpdateRegularAssetAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetAttribute->Notes" } ] } } }, "DeleteRegularAssetAttributeResourceActionRequest": { "title": "DeleteRegularAssetAttributeResourceActionRequest", "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 } } }, "BatchGetRegularAssetAttributeResourceAction": { "title": "BatchGetRegularAssetAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Attribute entities", "items": { "$ref": "#/definitions/GetRegularAssetAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetAttributeResourceActionRequest": { "title": "BatchCreateRegularAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetAttributeResourceActionRequest" } }, "BatchUpdateRegularAssetAttributeResourceActionRequest": { "title": "BatchUpdateRegularAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetAttributeResourceActionRequest" } }, "BatchDeleteRegularAssetAttributeResourceActionRequest": { "title": "BatchDeleteRegularAssetAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetAttributeResourceActionRequest" } }, "ChangeRegularAssetAttributeIsActiveResourceActionRequest": { "title": "ChangeRegularAssetAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetAttribute->IsActive" } ] } } }, "ChangeRegularAssetAttributePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetAttributePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetAttributeIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetAttributePermissionTreeResourceActionRequest" } }, "GetRegularAssetComponentResourceActionResponse": { "title": "GetRegularAssetComponentResourceActionResponse", "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": "GetRegularAssetComponentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->RulesLastEvaluatedOn" }, "unsubscribed": { "title": "unsubscribed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Unsubscribed" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_Code" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_Description" }, "assetAssetTypeId": { "title": "assetAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_AssetType_Id" }, "assetAssetTypeRecordType": { "title": "assetAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetTreePathId": { "title": "assetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_TreePathId" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->LastConfirmedOn" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ParentComponent_Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SequenceNumber" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Site_Description" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Unsynchronised" }, "treePathId": { "title": "treePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->TreePathId" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->AlternativeDescription" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetImportance_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetType_Description" }, "barcode": { "title": "barcode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Barcode" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetComponent->CommissionedOn" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->InheritedFrom_LastConfirmedOn" }, "inheritedFromRulesLastChangedOn": { "title": "inheritedFromRulesLastChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->InheritedFrom_RulesLastChangedOn" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Notes" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->PartNumber" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->QRCode" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Quantity" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->RFId" }, "serialNumber": { "title": "serialNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SerialNumber" }, "specification": { "title": "specification", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Specification" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Supplier_Description" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SupplierPartNumber" }, "warranty": { "title": "warranty", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Warranty", "x-formatSpecifier": "Warranty" } } }, "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" } } }, "GetRegularAssetComponentCollectionResourceActionResponse": { "title": "GetRegularAssetComponentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetComponentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetComponentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->AlternativeDescription" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SequenceNumber" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->PartNumber" }, "qRCode": { "title": "qRCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->QRCode" }, "rFId": { "title": "rFId", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->RFId" }, "specification": { "title": "specification", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Specification" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SupplierPartNumber" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetComponent->CommissionedOn" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Quantity" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->AssetImportance_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Site_Description" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Id" }, "commissioningWorkOrderCode": { "title": "commissioningWorkOrderCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Code" }, "commissioningWorkOrderDescription": { "title": "commissioningWorkOrderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Description" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetType_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Asset_Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetComponent->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ParentComponent_Id" }, "parentComponentCode": { "title": "parentComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ParentComponent_Code" }, "parentComponentDescription": { "title": "parentComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->ParentComponent_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Supplier_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->InheritedFrom_Id" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->IsHistorical" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Notes" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->RuleEvaluationPassed" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponent->ModifiedOn" }, "treePathItems": { "title": "treePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetComponent->TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetComponentParentComponentLookupResourceActionResponse": { "title": "AssetComponentParentComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetComponentParentComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetComponentParentComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AssetComponent->RecordType", "x-formatSpecifier": "AssetComponentRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetComponentAssetLookupResourceActionResponse": { "title": "RegularAssetComponentAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetComponentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetComponentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentCommissioningWorkOrderLookupResourceActionResponse": { "title": "RegularAssetComponentCommissioningWorkOrderLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentCommissioningWorkOrderLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentCommissioningWorkOrderLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrder->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetComponentImportanceLookupResourceActionResponse": { "title": "RegularAssetComponentImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentImportanceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetComponentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentsMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetComponentsMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentsMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentsMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentsSiteLookupResourceActionResponse": { "title": "RegularAssetComponentsSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentsSiteLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentsSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetComponentSupplierLookupResourceActionResponse": { "title": "RegularAssetComponentSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetComponentResourceActionRequest": { "title": "CreateRegularAssetComponentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetComponentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetId", "description", "alternativeDescription", "quantity" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetComponent->Asset_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetComponent->AlternativeDescription" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Site_Id", "x-systemGenerated": true }, "parentComponentId": { "title": "parentComponentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetComponent->ParentComponent_Id" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetComponent->Quantity" }, "partNumber": { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->PartNumber" }, "qRCode": { "title": "qRCode", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->QRCode" }, "rFId": { "title": "rFId", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->RFId" }, "specification": { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Specification" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Supplier_Id" }, "supplierPartNumber": { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SupplierPartNumber" }, "commissionedOn": { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetComponent->CommissionedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SequenceNumber" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetImportance_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Id" }, "commissioningWorkOrderId": { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Id" }, "barcode": { "title": "barcode", "type": "string", "maxLength": 900, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Barcode" }, "serialNumber": { "title": "serialNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SerialNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetComponentResourceActionRequest": { "title": "UpdateRegularAssetComponentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponent->Code", "x-ReadOnlyExpression": "RegularAssetComponent->IsInherited eq true" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Description", "x-ReadOnlyExpression": "RegularAssetComponent->IsInherited eq true" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetComponent->AlternativeDescription" }, { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetComponent->Quantity" }, { "title": "partNumber", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->PartNumber" }, { "title": "qRCode", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->QRCode" }, { "title": "rFId", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->RFId" }, { "title": "specification", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Specification" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SequenceNumber" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Supplier_Id" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->MaterialMaster_Id" }, { "title": "supplierPartNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SupplierPartNumber" }, { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->AssetImportance_Id" }, { "title": "barcode", "type": "string", "maxLength": 900, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Barcode" }, { "title": "serialNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "RegularAssetComponent->SerialNumber" }, { "title": "commissionedOn", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetComponent->CommissionedOn" }, { "title": "commissioningWorkOrderId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->CommissioningWorkOrder_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponent->Notes" } ] } } }, "DeleteRegularAssetComponentResourceActionRequest": { "title": "DeleteRegularAssetComponentResourceActionRequest", "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 } } }, "BatchGetRegularAssetComponentResourceAction": { "title": "BatchGetRegularAssetComponentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Component entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Component entities", "items": { "$ref": "#/definitions/GetRegularAssetComponentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetComponentResourceActionRequest": { "title": "BatchCreateRegularAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetComponentResourceActionRequest" } }, "BatchUpdateRegularAssetComponentResourceActionRequest": { "title": "BatchUpdateRegularAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetComponentResourceActionRequest" } }, "BatchDeleteRegularAssetComponentResourceActionRequest": { "title": "BatchDeleteRegularAssetComponentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetComponentResourceActionRequest" } }, "ChangeRegularAssetComponentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetComponentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponent->IsActive" } ] } } }, "ChangeRegularAssetComponentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetComponentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponent->PermissionTree_Id" } ] } } }, "ResubscribeRegularAssetComponentDevelopmentStatusResourceActionRequest": { "title": "ResubscribeRegularAssetComponentDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ResubscribeRegularAssetComponentDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UnsubscribeRegularAssetComponentDevelopmentStatusResourceActionRequest": { "title": "UnsubscribeRegularAssetComponentDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "UnsubscribeRegularAssetComponentDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeRegularAssetComponentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetComponentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetComponentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetComponentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetComponentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetComponentPermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetComponentResourceActionRequest": { "title": "MatchUpdateRegularAssetComponentResourceActionRequest", "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": "RegularAssetComponent->Quantity" } ] } } }, "GetRegularAssetComponentAttributeResourceActionResponse": { "title": "GetRegularAssetComponentAttributeResourceActionResponse", "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": "GetRegularAssetComponentAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->InheritedFrom_Id" }, "regularAssetComponentId": { "title": "regularAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->RegularAssetComponent_Id" }, "regularAssetComponentCode": { "title": "regularAssetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->RegularAssetComponent_Code" }, "regularAssetComponentDescription": { "title": "regularAssetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->RegularAssetComponent_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->SynchronisedWithTypeObjectUpTo" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->IsHistorical" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Unsynchronised" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->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" } } }, "GetRegularAssetComponentAttributeCollectionForRegularAssetComponentResourceActionResponse": { "title": "GetRegularAssetComponentAttributeCollectionForRegularAssetComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetComponentAttributeCollectionForRegularAssetComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetComponentAttributeCollectionForRegularAssetComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->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" } } } }, "GetRegularAssetComponentAttributeCollectionResourceActionResponse": { "title": "GetRegularAssetComponentAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetComponentAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetComponentAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->IsInherited" }, "regularAssetComponentCode": { "title": "regularAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->RegularAssetComponent_Code" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentAttribute->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" } } } }, "RegularAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RegularAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentAttributeAttributeLookupResourceActionResponse": { "title": "RegularAssetComponentAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetComponentAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentAttributeRegularAssetComponentLookupResourceActionResponse": { "title": "RegularAssetComponentAttributeRegularAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentAttributeRegularAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentAttributeRegularAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetComponentAttributeResourceActionRequest": { "title": "CreateRegularAssetComponentAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetComponentAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetComponentId", "attributeId" ], "properties": { "regularAssetComponentId": { "title": "regularAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->RegularAssetComponent_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetComponentAttributeResourceActionRequest": { "title": "UpdateRegularAssetComponentAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponentAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentAttribute->Notes" } ] } } }, "DeleteRegularAssetComponentAttributeResourceActionRequest": { "title": "DeleteRegularAssetComponentAttributeResourceActionRequest", "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 } } }, "BatchGetRegularAssetComponentAttributeResourceAction": { "title": "BatchGetRegularAssetComponentAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Component Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Component Attribute entities", "items": { "$ref": "#/definitions/GetRegularAssetComponentAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetComponentAttributeResourceActionRequest": { "title": "BatchCreateRegularAssetComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetComponentAttributeResourceActionRequest" } }, "BatchUpdateRegularAssetComponentAttributeResourceActionRequest": { "title": "BatchUpdateRegularAssetComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetComponentAttributeResourceActionRequest" } }, "BatchDeleteRegularAssetComponentAttributeResourceActionRequest": { "title": "BatchDeleteRegularAssetComponentAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetComponentAttributeResourceActionRequest" } }, "ChangeRegularAssetComponentAttributeIsActiveResourceActionRequest": { "title": "ChangeRegularAssetComponentAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponentAttribute->IsActive" } ] } } }, "ChangeRegularAssetComponentAttributePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetComponentAttributePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponentAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetComponentAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetComponentAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetComponentAttributeIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetComponentAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetComponentAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetComponentAttributePermissionTreeResourceActionRequest" } }, "GetRegularAssetComponentDocumentResourceActionResponse": { "title": "GetRegularAssetComponentDocumentResourceActionResponse", "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": "GetRegularAssetComponentDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->InheritedFrom_Id" }, "regularAssetComponentId": { "title": "regularAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->RegularAssetComponent_Id" }, "regularAssetComponentCode": { "title": "regularAssetComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->RegularAssetComponent_Code" }, "regularAssetComponentDescription": { "title": "regularAssetComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->RegularAssetComponent_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->Unsynchronised" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->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" } } }, "GetRegularAssetComponentDocumentCollectionForRegularAssetComponentResourceActionResponse": { "title": "GetRegularAssetComponentDocumentCollectionForRegularAssetComponentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetComponentDocumentCollectionForRegularAssetComponentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetComponentDocumentCollectionForRegularAssetComponentResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->InheritedFrom_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->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" } } } }, "GetRegularAssetComponentDocumentCollectionResourceActionResponse": { "title": "GetRegularAssetComponentDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetComponentDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetComponentDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetComponentCode": { "title": "regularAssetComponentCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->RegularAssetComponent_Code" }, "regularAssetComponentDescription": { "title": "regularAssetComponentDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->RegularAssetComponent_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetComponentDocument->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" } } } }, "RegularAssetComponentDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetComponentDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentDocumentDocumentLookupResourceActionResponse": { "title": "RegularAssetComponentDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetComponentDocumentRegularAssetComponentLookupResourceActionResponse": { "title": "RegularAssetComponentDocumentRegularAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetComponentDocumentRegularAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetComponentDocumentRegularAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetComponent->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetComponentDocumentResourceActionRequest": { "title": "CreateRegularAssetComponentDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetComponentDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetComponentId", "documentRecordId" ], "properties": { "regularAssetComponentId": { "title": "regularAssetComponentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->RegularAssetComponent_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetComponentDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetComponentDocumentResourceActionRequest": { "title": "UpdateRegularAssetComponentDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponentDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetComponentDocument->Notes" } ] } } }, "DeleteRegularAssetComponentDocumentResourceActionRequest": { "title": "DeleteRegularAssetComponentDocumentResourceActionRequest", "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 } } }, "BatchGetRegularAssetComponentDocumentResourceAction": { "title": "BatchGetRegularAssetComponentDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Component Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Component Document entities", "items": { "$ref": "#/definitions/GetRegularAssetComponentDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetComponentDocumentResourceActionRequest": { "title": "BatchCreateRegularAssetComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetComponentDocumentResourceActionRequest" } }, "BatchUpdateRegularAssetComponentDocumentResourceActionRequest": { "title": "BatchUpdateRegularAssetComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetComponentDocumentResourceActionRequest" } }, "BatchDeleteRegularAssetComponentDocumentResourceActionRequest": { "title": "BatchDeleteRegularAssetComponentDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetComponentDocumentResourceActionRequest" } }, "ChangeRegularAssetComponentDocumentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetComponentDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponentDocument->IsActive" } ] } } }, "ChangeRegularAssetComponentDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetComponentDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetComponentDocument->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetComponentDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetComponentDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetComponentDocumentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetComponentDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetComponentDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetComponentDocumentPermissionTreeResourceActionRequest" } }, "GetRegularAssetConditionResourceActionResponse": { "title": "GetRegularAssetConditionResourceActionResponse", "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": "GetRegularAssetConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetCondition->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetCondition->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->PermissionTree_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Condition_ConditionType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetCondition->InheritedFrom_LastConfirmedOn" }, "inheritedFromConditionId": { "title": "inheritedFromConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Condition_Id" }, "inheritedFromConditionCode": { "title": "inheritedFromConditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Condition_Code" }, "inheritedFromConditionDescription": { "title": "inheritedFromConditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Condition_Description" }, "inheritedFromConditionConditionTypeId": { "title": "inheritedFromConditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Condition_ConditionType_Id" }, "inheritedFromConditionConditionTypeCode": { "title": "inheritedFromConditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Condition_ConditionType_Code" }, "inheritedFromConditionConditionTypeDescription": { "title": "inheritedFromConditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Condition_ConditionType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->RecordType", "x-formatSpecifier": "AssetRecordType" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->RegularAsset_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->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" } } }, "GetRegularAssetConditionCollectionResourceActionResponse": { "title": "GetRegularAssetConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->RegularAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_ConditionType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->State", "x-formatSpecifier": "ConditionState" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->IsActive" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->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" } } } }, "GetRegularAssetConditionForAssetCollectionResourceActionResponse": { "title": "GetRegularAssetConditionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetConditionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetConditionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->RegularAsset_Description" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_Description" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_ConditionType_Description" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->AdjustmentFactor" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->State", "x-formatSpecifier": "ConditionState" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->IsInherited" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->IsActive" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConditionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetConditionConditionLookupResourceActionResponse": { "title": "RegularAssetConditionConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConditionConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConditionConditionLookupResourceActionResponseItemProperties", "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" }, "conditionTypeId": { "title": "conditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Condition->ConditionType_Id" }, "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" } } } }, "RegularAssetConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetConditionRegularAssetLookupResourceActionResponse": { "title": "RegularAssetConditionRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConditionRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConditionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetConditionResourceActionRequest": { "title": "CreateRegularAssetConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "conditionId", "state" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->SequenceNumber" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetCondition->RegularAsset_Id" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "RegularAssetCondition->InheritedFrom_Id" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->Condition_Id" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->State", "x-formatSpecifier": "ConditionState" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetConditionResourceActionRequest": { "title": "UpdateRegularAssetConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetCondition->SequenceNumber" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->AdjustmentFactor" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetCondition->Notes" } ] } } }, "DeleteRegularAssetConditionResourceActionRequest": { "title": "DeleteRegularAssetConditionResourceActionRequest", "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 } } }, "BatchGetRegularAssetConditionResourceAction": { "title": "BatchGetRegularAssetConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Condition entities", "items": { "$ref": "#/definitions/GetRegularAssetConditionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetConditionResourceActionRequest": { "title": "BatchCreateRegularAssetConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetConditionResourceActionRequest" } }, "BatchUpdateRegularAssetConditionResourceActionRequest": { "title": "BatchUpdateRegularAssetConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetConditionResourceActionRequest" } }, "BatchDeleteRegularAssetConditionResourceActionRequest": { "title": "BatchDeleteRegularAssetConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetConditionResourceActionRequest" } }, "ChangeRegularAssetConditionIsActiveResourceActionRequest": { "title": "ChangeRegularAssetConditionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetCondition->IsActive" } ] } } }, "ChangeRegularAssetConditionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetCondition->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetConditionIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetConditionIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetConditionPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetConditionPermissionTreeResourceActionRequest" } }, "GetRegularAssetConsumptionResourceActionResponse": { "title": "GetRegularAssetConsumptionResourceActionResponse", "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": "GetRegularAssetConsumptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->PermissionTree_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->ConsumedOn" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostElement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Currency_Description" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CurrencyRate_Id" }, "currencyRateUserSuppliedConversionRate": { "title": "currencyRateUserSuppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CurrencyRate_UserSuppliedConversionRate" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CurrencyRate_AppliedConversionRate" }, "currencyRateValue": { "title": "currencyRateValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CurrencyRateValue" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Location_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Meter_Id", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Meter_Description" }, "meterUnitOfMeasurementId": { "title": "meterUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Meter_UnitOfMeasurement_Id" }, "meterUnitOfMeasurementCode": { "title": "meterUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Meter_UnitOfMeasurement_Code" }, "meterUnitOfMeasurementDescription": { "title": "meterUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Meter_UnitOfMeasurement_Description" }, "meterReadingId": { "title": "meterReadingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->MeterReading_Id" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->MeterReadingOn", "x-NullExpression": "RegularAssetConsumption->MeterReadingValue ne NULL" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->MeterReadingValue", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Site_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->SiteCurrency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->SiteCurrency_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_AlternativeDescription" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_MaterialMaster_Code" }, "stockItemMaterialMasterDescription": { "title": "stockItemMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_MaterialMaster_Description" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Warehouse_Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Supplier_Description" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->TotalCostInSiteCurrency" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitPrice" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetCostingCollectionForRegularAssetConsumptionResourceActionResponse": { "title": "GetCostingCollectionForRegularAssetConsumptionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetCostingCollectionForRegularAssetConsumptionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetCostingCollectionForRegularAssetConsumptionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->Quantity" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostElement_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->CostCentre_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->GeneralLedger_Description" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInSiteCurrency" }, "totalCostInBaseCurrency": { "title": "totalCostInBaseCurrency", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Costing->TotalCostInBaseCurrency" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Costing->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Costing->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetConsumptionCollectionResourceActionResponse": { "title": "GetRegularAssetConsumptionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetConsumptionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetConsumptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->ConsumedOn" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostElement_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Site_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_AlternativeDescription" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Quantity" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Meter_Description" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->MeterReadingValue", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->MeterReadingOn", "x-NullExpression": "RegularAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Supplier_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->SiteCurrency_Code" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CurrencyRate_Id" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CurrencyRate_AppliedConversionRate" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitPrice" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->TotalCostInSiteCurrency" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetConsumptionForAssetCollectionResourceActionResponse": { "title": "GetRegularAssetConsumptionForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetConsumptionForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetConsumptionForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Description" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Consumable_Id" }, "consumableCode": { "title": "consumableCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Consumable_Code" }, "consumableDescription": { "title": "consumableDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Consumable_Description" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->ConsumedOn" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Id" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_FinancialYear_Description" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostCentre_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostElement_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_AlternativeDescription" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Quantity" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Site_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Meter_Description" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->MeterReadingValue", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->MeterReadingOn", "x-NullExpression": "RegularAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Supplier_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->SiteCurrency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->SiteCurrency_Code" }, "currencyRateId": { "title": "currencyRateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->CurrencyRate_Id" }, "currencyRateAppliedConversionRate": { "title": "currencyRateAppliedConversionRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CurrencyRate_AppliedConversionRate" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitPrice" }, "totalCost": { "title": "totalCost", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->TotalCost" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->TotalCostInSiteCurrency" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetConsumptionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetConsumptionConsumableLookupResourceActionResponse": { "title": "RegularAssetConsumptionConsumableLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionConsumableLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionConsumableLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Consumable->UnitPrice" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionCostCentreLookupResourceActionResponse": { "title": "RegularAssetConsumptionCostCentreLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionCostCentreLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionCostCentreLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostCentre->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionCostElementLookupResourceActionResponse": { "title": "RegularAssetConsumptionCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetConsumptionCurrencyLookupResourceActionResponse": { "title": "RegularAssetConsumptionCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionCurrencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionFinancialYearPeriodLookupResourceActionResponse": { "title": "RegularAssetConsumptionFinancialYearPeriodLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionFinancialYearPeriodLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionGeneralLedgerLookupResourceActionResponse": { "title": "RegularAssetConsumptionGeneralLedgerLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionGeneralLedgerLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionGeneralLedgerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "GeneralLedger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetConsumptionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetConsumptionMeterLookupResourceActionResponse": { "title": "RegularAssetConsumptionMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionMeterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionRegularAssetLookupResourceActionResponse": { "title": "RegularAssetConsumptionRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Site_Id" }, "siteFinancialYearPeriodId": { "title": "siteFinancialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Site_FinancialYearPeriod_Id" }, "siteFinancialYearPeriodCode": { "title": "siteFinancialYearPeriodCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_FinancialYearPeriod_Code" }, "siteFinancialYearPeriodDescription": { "title": "siteFinancialYearPeriodDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_FinancialYearPeriod_Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Site_Currency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Currency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Currency_Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Description" }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->CostCentre_Id" }, "costCentreCode": { "title": "costCentreCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Code" }, "costCentreDescription": { "title": "costCentreDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->CostCentre_Description" }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->GeneralLedger_Id" }, "generalLedgerCode": { "title": "generalLedgerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Code" }, "generalLedgerDescription": { "title": "generalLedgerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->GeneralLedger_Description" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Location_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionResourceLookupResourceActionResponse": { "title": "RegularAssetConsumptionResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionResourceLookupResourceActionResponseItemProperties", "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" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->CostElement_Description" }, "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" } } } }, "RegularAssetConsumptionStockItemLookupResourceActionResponse": { "title": "RegularAssetConsumptionStockItemLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionStockItemLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionSupplierLookupResourceActionResponse": { "title": "RegularAssetConsumptionSupplierLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionSupplierLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Description" }, "siteCurrencyId": { "title": "siteCurrencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->Site_Currency_Id" }, "siteCurrencyCode": { "title": "siteCurrencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Currency_Code" }, "siteCurrencyDescription": { "title": "siteCurrencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Currency_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetConsumptionUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetConsumptionUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetConsumptionUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetConsumptionUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetConsumptionResourceActionRequest": { "title": "CreateRegularAssetConsumptionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetConsumptionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "consumableId", "quantity" ], "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->RegularAsset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->PermissionTree_Id", "x-systemGenerated": true }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Id" }, "consumableId": { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Consumable_Id" }, "consumedOn": { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->ConsumedOn", "x-systemGenerated": true }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Id", "x-systemGenerated": true }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetConsumption->UnitPrice", "x-systemGenerated": true }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Quantity" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Meter_Id", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingValue": { "title": "meterReadingValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->MeterReadingValue", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, "meterReadingOn": { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->MeterReadingOn", "x-NullExpression": "RegularAssetConsumption->MeterReadingValue ne NULL" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Supplier_Id" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Currency_Id", "x-systemGenerated": true }, "costCentreId": { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostCentre_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostElement_Id", "x-systemGenerated": true }, "generalLedgerId": { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Id", "x-systemGenerated": true }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetConsumptionResourceActionRequest": { "title": "UpdateRegularAssetConsumptionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Resource_Id" }, { "title": "consumableId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Consumable_Id" }, { "title": "consumedOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->ConsumedOn" }, { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->StockItem_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->UnitOfMeasurement_Id" }, { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Quantity" }, { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Meter_Id", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, { "title": "meterReadingValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->MeterReadingValue", "x-NullExpression": "RegularAssetConsumption->MeterReadingOn ne NULL" }, { "title": "meterReadingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetConsumption->MeterReadingOn", "x-NullExpression": "RegularAssetConsumption->MeterReadingValue ne NULL" }, { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Supplier_Id" }, { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->Currency_Id" }, { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetConsumption->UnitPrice" }, { "title": "costCentreId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostCentre_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->CostElement_Id" }, { "title": "generalLedgerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->GeneralLedger_Id" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetConsumption->FinancialYearPeriod_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetConsumption->Notes" } ] } } }, "DeleteRegularAssetConsumptionResourceActionRequest": { "title": "DeleteRegularAssetConsumptionResourceActionRequest", "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 } } }, "BatchGetRegularAssetConsumptionResourceAction": { "title": "BatchGetRegularAssetConsumptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Consumption entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Consumption entities", "items": { "$ref": "#/definitions/GetRegularAssetConsumptionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetConsumptionResourceActionRequest": { "title": "BatchCreateRegularAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetConsumptionResourceActionRequest" } }, "BatchUpdateRegularAssetConsumptionResourceActionRequest": { "title": "BatchUpdateRegularAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetConsumptionResourceActionRequest" } }, "BatchDeleteRegularAssetConsumptionResourceActionRequest": { "title": "BatchDeleteRegularAssetConsumptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetConsumptionResourceActionRequest" } }, "ChangeRegularAssetConsumptionIsActiveResourceActionRequest": { "title": "ChangeRegularAssetConsumptionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetConsumption->IsActive" } ] } } }, "ChangeRegularAssetConsumptionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetConsumptionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetConsumption->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetConsumptionIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetConsumptionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetConsumptionIsActiveResourceActionRequest" } }, "GetRegularAssetDocumentResourceActionResponse": { "title": "GetRegularAssetDocumentResourceActionResponse", "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": "GetRegularAssetDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->InheritedFrom_Id" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->RegularAsset_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->Unsynchronised" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->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" } } }, "GetRegularAssetDocumentCollectionForRegularAssetResourceActionResponse": { "title": "GetRegularAssetDocumentCollectionForRegularAssetResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetDocumentCollectionForRegularAssetResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetDocumentCollectionForRegularAssetResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->Notes" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->InheritedFrom_Id" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->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" } } } }, "GetRegularAssetDocumentCollectionResourceActionResponse": { "title": "GetRegularAssetDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->RegularAsset_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->IsInherited" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetDocument->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" } } } }, "RegularAssetDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetDocumentDocumentLookupResourceActionResponse": { "title": "RegularAssetDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetDocumentRegularAssetLookupResourceActionResponse": { "title": "RegularAssetDocumentRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetDocumentRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetDocumentRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetDocumentResourceActionRequest": { "title": "CreateRegularAssetDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "documentRecordId" ], "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->RegularAsset_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetDocumentResourceActionRequest": { "title": "UpdateRegularAssetDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetDocument->Notes" } ] } } }, "DeleteRegularAssetDocumentResourceActionRequest": { "title": "DeleteRegularAssetDocumentResourceActionRequest", "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 } } }, "BatchGetRegularAssetDocumentResourceAction": { "title": "BatchGetRegularAssetDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Document entities", "items": { "$ref": "#/definitions/GetRegularAssetDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetDocumentResourceActionRequest": { "title": "BatchCreateRegularAssetDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetDocumentResourceActionRequest" } }, "BatchUpdateRegularAssetDocumentResourceActionRequest": { "title": "BatchUpdateRegularAssetDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetDocumentResourceActionRequest" } }, "BatchDeleteRegularAssetDocumentResourceActionRequest": { "title": "BatchDeleteRegularAssetDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetDocumentResourceActionRequest" } }, "ChangeRegularAssetDocumentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetDocument->IsActive" } ] } } }, "ChangeRegularAssetDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetDocument->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetDocumentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetDocumentPermissionTreeResourceActionRequest" } }, "GetRegularAssetFileAttachmentResourceActionResponse": { "title": "GetRegularAssetFileAttachmentResourceActionResponse", "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": "GetRegularAssetFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "RegularAssetFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->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" } } }, "GetRegularAssetFileAttachmentCollectionForRegularAssetResourceActionResponse": { "title": "GetRegularAssetFileAttachmentCollectionForRegularAssetResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetFileAttachmentCollectionForRegularAssetResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetFileAttachmentCollectionForRegularAssetResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetFileAttachment->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" } } } }, "GetRegularAssetFileAttachmentCollectionResourceActionResponse": { "title": "GetRegularAssetFileAttachmentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetFileAttachmentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetFileAttachment->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" } } } }, "CreateRegularAssetFileAttachmentResourceActionRequest": { "title": "CreateRegularAssetFileAttachmentResourceActionRequest", "type": "object", "required": [ "regularAssetId" ], "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateRegularAssetFileAttachmentContentResourceActionRequest": { "title": "UpdateRegularAssetFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateRegularAssetFileAttachmentResourceActionRequest": { "title": "UpdateRegularAssetFileAttachmentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->IsRestricted" } ] } } }, "DeleteRegularAssetFileAttachmentResourceResourceActionRequest": { "title": "DeleteRegularAssetFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetRegularAssetFileAttachmentResourceAction": { "title": "BatchGetRegularAssetFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset File Attachment entities", "items": { "$ref": "#/definitions/GetRegularAssetFileAttachmentResourceActionResponse" } }, "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" } } }, "GetRegularAssetFileAttachmentContentHistoryResourceActionResponse": { "title": "GetRegularAssetFileAttachmentContentHistoryResourceActionResponse", "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" } } }, "GetRegularAssetFileAttachmentContentHistoryResourceAction": { "title": "GetRegularAssetFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset File Attachment entities", "items": { "$ref": "#/definitions/GetRegularAssetFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetFileAttachmentResourceActionRequest": { "title": "BatchCreateRegularAssetFileAttachmentResourceActionRequest", "type": "object", "required": [ "regularAssetId" ], "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->RegularAsset_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateRegularAssetFileAttachmentResourceActionRequest": { "title": "BatchUpdateRegularAssetFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetFileAttachmentResourceActionRequest" } }, "BatchDeleteRegularAssetFileAttachmentResourceActionRequest": { "title": "BatchDeleteRegularAssetFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetFileAttachmentResourceResourceActionRequest" } }, "GetRegularAssetMeterResourceActionResponse": { "title": "GetRegularAssetMeterResourceActionResponse", "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": "GetRegularAssetMeterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMeter->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMeter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->PermissionTree_Description" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->RegularAsset_Description" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->IsMainMeter" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->Meter_Description" }, "assetMeterType": { "title": "assetMeterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->AssetMeterType", "x-formatSpecifier": "EntityType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->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" } } }, "GetRegularAssetMeterCollectionResourceActionResponse": { "title": "GetRegularAssetMeterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetMeterCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->RegularAsset_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->Meter_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->IsActive" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->IsMainMeter" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->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" } } } }, "GetRegularAssetMeterForAssetCollectionResourceActionResponse": { "title": "GetRegularAssetMeterForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetMeterForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetMeterForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->Meter_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->IsActive" }, "isMainMeter": { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->IsMainMeter" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->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" } } } }, "RegularAssetMeterAssetLookupResourceActionResponse": { "title": "RegularAssetMeterAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMeterAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMeterAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAsset->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetMeterChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetMeterChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMeterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMeterChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetMeterInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetMeterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMeterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMeterInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetMeterMeterLookupResourceActionResponse": { "title": "RegularAssetMeterMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMeterMeterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMeterMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetMeterResourceActionRequest": { "title": "CreateRegularAssetMeterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetMeterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "meterId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->PermissionTree_Id", "x-systemGenerated": true }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetMeter->RegularAsset_Id" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->Meter_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetMeterResourceActionRequest": { "title": "UpdateRegularAssetMeterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetMeter->SequenceNumber" }, { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMeter->IsMainMeter" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMeter->Notes" } ] } } }, "DeleteRegularAssetMeterResourceActionRequest": { "title": "DeleteRegularAssetMeterResourceActionRequest", "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 } } }, "BatchGetRegularAssetMeterResourceAction": { "title": "BatchGetRegularAssetMeterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Meter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Meter entities", "items": { "$ref": "#/definitions/GetRegularAssetMeterResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetMeterResourceActionRequest": { "title": "BatchCreateRegularAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetMeterResourceActionRequest" } }, "BatchUpdateRegularAssetMeterResourceActionRequest": { "title": "BatchUpdateRegularAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetMeterResourceActionRequest" } }, "BatchDeleteRegularAssetMeterResourceActionRequest": { "title": "BatchDeleteRegularAssetMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetMeterResourceActionRequest" } }, "ChangeRegularAssetMeterIsActiveResourceActionRequest": { "title": "ChangeRegularAssetMeterIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetMeter->IsActive" } ] } } }, "SetMainMeterStatusResourceActionRequest": { "title": "SetMainMeterStatusResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isMainMeter", "type": "boolean", "x-nullable": false, "x-propertyPath": "SetRegularAssetMainMeterStatus->IsMainMeter" } ] } } }, "BatchChangeRegularAssetMeterIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetMeterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetMeterIsActiveResourceActionRequest" } }, "GetRegularAssetMonitoringPointTriggerResourceActionResponse": { "title": "GetRegularAssetMonitoringPointTriggerResourceActionResponse", "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": "GetRegularAssetMonitoringPointTriggerResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMonitoringPointTrigger->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMonitoringPointTrigger->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMonitoringPointTrigger->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMonitoringPointTrigger->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->InheritedFrom_Id" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Code" }, "monitoringPointTriggerDescription": { "title": "monitoringPointTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->RecordType", "x-formatSpecifier": "AssetRecordType" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->RegularAsset_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" } } }, "GetRegularAssetMonitoringPointTriggerCollectionResourceActionResponse": { "title": "GetRegularAssetMonitoringPointTriggerCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetMonitoringPointTriggerCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetMonitoringPointTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->IsActive" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->RegularAsset_Code" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Code" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->PermissionTree_Code" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->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" } } } }, "GetRegularAssetMonitoringPointTriggerForRegularAssetCollectionResourceActionResponse": { "title": "GetRegularAssetMonitoringPointTriggerForRegularAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetMonitoringPointTriggerForRegularAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetMonitoringPointTriggerForRegularAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Code" }, "monitoringPointTriggerDescription": { "title": "monitoringPointTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetMonitoringPointTriggerResourceLookupMonitoringPointTriggerActionResponse": { "title": "RegularAssetMonitoringPointTriggerResourceLookupMonitoringPointTriggerActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerResourceLookupMonitoringPointTriggerActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerResourceLookupMonitoringPointTriggerActionResponseItemProperties", "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" } } } }, "RegularAssetMonitoringPointTriggerRegularAssetLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetMonitoringPointTriggerResourceActionRequest": { "title": "CreateRegularAssetMonitoringPointTriggerResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetMonitoringPointTriggerResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "monitoringPointTriggerId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->PermissionTree_Id", "x-systemGenerated": true }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->RegularAsset_Id" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTrigger->MonitoringPointTrigger_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetMonitoringPointTriggerResourceActionRequest": { "title": "UpdateRegularAssetMonitoringPointTriggerResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetMonitoringPointTrigger->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTrigger->Notes" } ] } } }, "DeleteRegularAssetMonitoringPointTriggerResourceActionRequest": { "title": "DeleteRegularAssetMonitoringPointTriggerResourceActionRequest", "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 } } }, "BatchGetRegularAssetMonitoringPointTriggerResourceAction": { "title": "BatchGetRegularAssetMonitoringPointTriggerResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Monitoring Point Trigger entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Monitoring Point Trigger entities", "items": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetMonitoringPointTriggerResourceActionRequest": { "title": "BatchCreateRegularAssetMonitoringPointTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetMonitoringPointTriggerResourceActionRequest" } }, "BatchUpdateRegularAssetMonitoringPointTriggerResourceActionRequest": { "title": "BatchUpdateRegularAssetMonitoringPointTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetMonitoringPointTriggerResourceActionRequest" } }, "BatchDeleteRegularAssetMonitoringPointTriggerResourceActionRequest": { "title": "BatchDeleteRegularAssetMonitoringPointTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetMonitoringPointTriggerResourceActionRequest" } }, "ChangeRegularAssetMonitoringPointTriggerIsActiveResourceActionRequest": { "title": "ChangeRegularAssetMonitoringPointTriggerIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetMonitoringPointTrigger->IsActive" } ] } } }, "ChangeRegularAssetMonitoringPointTriggerPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetMonitoringPointTriggerPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetMonitoringPointTrigger->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetMonitoringPointTriggerIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetMonitoringPointTriggerIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetMonitoringPointTriggerIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetMonitoringPointTriggerPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetMonitoringPointTriggerPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetMonitoringPointTriggerPermissionTreeResourceActionRequest" } }, "GetRegularAssetMonitoringPointTriggerParameterResourceActionResponse": { "title": "GetRegularAssetMonitoringPointTriggerParameterResourceActionResponse", "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": "GetRegularAssetMonitoringPointTriggerParameterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->SequenceNumber" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_Id" }, "inheritedFromMonitoringPointTriggerExpressionParameterId": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_Id" }, "inheritedFromMonitoringPointTriggerExpressionParameterParameterName": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterParameterName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_ParameterName" }, "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id" }, "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description" }, "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression" }, "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Id" }, "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Code" }, "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription": { "title": "inheritedFromMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Description" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Description" }, "monitoringPointTriggerExpressionParameterId": { "title": "monitoringPointTriggerExpressionParameterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id" }, "monitoringPointTriggerExpressionParameterParameterType": { "title": "monitoringPointTriggerExpressionParameterParameterType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterType", "x-formatSpecifier": "MonitoringPointTriggerExpressionParameterType" }, "monitoringPointTriggerExpressionParameterParameterName": { "title": "monitoringPointTriggerExpressionParameterParameterName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterName" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Id" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Code" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionMonitoringPointTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_MonitoringPointTrigger_Description" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeId": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Id" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeCode": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Code" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->Notes" }, "parameterValue": { "title": "parameterValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ParameterValue", "x-formatSpecifier": "DynamicValue" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_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" } } }, "GetRegularAssetMonitoringPointTriggerParameterCollectionResourceActionResponse": { "title": "GetRegularAssetMonitoringPointTriggerParameterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetMonitoringPointTriggerParameterCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetMonitoringPointTriggerParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->SequenceNumber" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Description" }, "monitoringPointTriggerExpressionParameterId": { "title": "monitoringPointTriggerExpressionParameterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id" }, "monitoringPointTriggerExpressionParameterParameterName": { "title": "monitoringPointTriggerExpressionParameterParameterName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterName" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeId": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Id" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeCode": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Code" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Description" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id" }, "parameterValue": { "title": "parameterValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ParameterValue", "x-formatSpecifier": "DynamicValue" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->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" } } } }, "GetRegularAssetMonitoringPointTriggerParameterForAssetCollectionResourceActionResponse": { "title": "GetRegularAssetMonitoringPointTriggerParameterForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetMonitoringPointTriggerParameterForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetMonitoringPointTriggerParameterForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->SequenceNumber" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Description" }, "monitoringPointTriggerExpressionParameterId": { "title": "monitoringPointTriggerExpressionParameterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id" }, "monitoringPointTriggerExpressionParameterParameterName": { "title": "monitoringPointTriggerExpressionParameterParameterName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_ParameterName" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionExpression", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Expression" }, "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeId": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Id" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeCode": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Code" }, "monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription": { "title": "monitoringPointTriggerExpressionParameterMonitoringPointTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_MonitoringPointType_Description" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Description" }, "parameterValue": { "title": "parameterValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ParameterValue", "x-formatSpecifier": "DynamicValue" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->InheritedFrom_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->PermissionTree_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" } } } }, "RegularAssetMonitoringPointTriggerParameterChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerParameterChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerParameterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetMonitoringPointTriggerParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerParameterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerParameterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetMonitoringPointTriggerParameterMonitoringPointLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerParameterMonitoringPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerParameterMonitoringPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerParameterMonitoringPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MonitoringPoint->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->Asset_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetMonitoringPointTriggerParameterMonitoringPointTriggerExpressionParameterLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerParameterMonitoringPointTriggerExpressionParameterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerParameterMonitoringPointTriggerExpressionParameterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerParameterMonitoringPointTriggerExpressionParameterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint'" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionExpression", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Expression" }, "monitoringPointTriggerExpressionMonitoringPointTriggerId": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Id" }, "monitoringPointTriggerExpressionMonitoringPointTriggerIdRegularAssetMonitoringPointTriggerMonitoringPointTriggerId": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerIdRegularAssetMonitoringPointTriggerMonitoringPointTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_*Id.RegularAssetMonitoringPointTrigger.MonitoringPointTrigger_Id" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description" }, "parameterType": { "title": "parameterType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterType", "x-formatSpecifier": "MonitoringPointTriggerExpressionParameterType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetMonitoringPointTriggerParameterRegularAssetLookupResourceActionResponse": { "title": "RegularAssetMonitoringPointTriggerParameterRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetMonitoringPointTriggerParameterRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetMonitoringPointTriggerParameterRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetMonitoringPointTriggerParameterResourceActionRequest": { "title": "CreateRegularAssetMonitoringPointTriggerParameterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetMonitoringPointTriggerParameterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "monitoringPointTriggerExpressionParameterId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->SequenceNumber" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->RegularAsset_Id" }, "monitoringPointTriggerExpressionParameterId": { "title": "monitoringPointTriggerExpressionParameterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPointTriggerExpressionParameter_Id" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id" }, "parameterValue": { "title": "parameterValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ParameterValue", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetMonitoringPointTriggerParameterResourceActionRequest": { "title": "UpdateRegularAssetMonitoringPointTriggerParameterResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetMonitoringPointTriggerParameter->SequenceNumber" }, { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->MonitoringPoint_Id" }, { "title": "parameterValue", "format": "composite", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->ParameterValue", "x-formatSpecifier": "DynamicValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetMonitoringPointTriggerParameter->Notes" } ] } } }, "DeleteRegularAssetMonitoringPointTriggerParameterResourceActionRequest": { "title": "DeleteRegularAssetMonitoringPointTriggerParameterResourceActionRequest", "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 } } }, "BatchGetRegularAssetMonitoringPointTriggerParameterResourceAction": { "title": "BatchGetRegularAssetMonitoringPointTriggerParameterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Monitoring Point Trigger Parameter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Monitoring Point Trigger Parameter entities", "items": { "$ref": "#/definitions/GetRegularAssetMonitoringPointTriggerParameterResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetMonitoringPointTriggerParameterResourceActionRequest": { "title": "BatchCreateRegularAssetMonitoringPointTriggerParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, "BatchUpdateRegularAssetMonitoringPointTriggerParameterResourceActionRequest": { "title": "BatchUpdateRegularAssetMonitoringPointTriggerParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, "BatchDeleteRegularAssetMonitoringPointTriggerParameterResourceActionRequest": { "title": "BatchDeleteRegularAssetMonitoringPointTriggerParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetMonitoringPointTriggerParameterResourceActionRequest" } }, "GetRegularAssetOptionValueResourceActionResponse": { "title": "GetRegularAssetOptionValueResourceActionResponse", "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": "GetRegularAssetOptionValueResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isCustom": { "title": "isCustom", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->IsCustom" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Id" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_AllowMultipleValues" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_Code" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_Description" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_LowerBounds" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_UpperBounds" }, "optionOptionCategoryId": { "title": "optionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Id" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Description" }, "optionUnitOfMeasurementId": { "title": "optionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Id" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Description" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Id" }, "regularAssetTypeOptionOptionId": { "title": "regularAssetTypeOptionOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Id" }, "regularAssetTypeOptionOptionCode": { "title": "regularAssetTypeOptionOptionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Code" }, "regularAssetTypeOptionOptionDescription": { "title": "regularAssetTypeOptionOptionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Description" }, "regularAssetTypeOptionOptionAllowMultipleValues": { "title": "regularAssetTypeOptionOptionAllowMultipleValues", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_AllowMultipleValues" }, "regularAssetTypeOptionOptionLowerBounds": { "title": "regularAssetTypeOptionOptionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_LowerBounds" }, "regularAssetTypeOptionOptionDataType": { "title": "regularAssetTypeOptionOptionDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_DataType", "x-formatSpecifier": "OptionDataType" }, "regularAssetTypeOptionOptionUpperBounds": { "title": "regularAssetTypeOptionOptionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_UpperBounds" }, "regularAssetTypeOptionOptionOptionCategoryId": { "title": "regularAssetTypeOptionOptionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Id" }, "regularAssetTypeOptionOptionOptionCategoryCode": { "title": "regularAssetTypeOptionOptionOptionCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Code" }, "regularAssetTypeOptionOptionOptionCategoryDescription": { "title": "regularAssetTypeOptionOptionOptionCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_OptionCategory_Description" }, "regularAssetTypeOptionOptionUnitOfMeasurementId": { "title": "regularAssetTypeOptionOptionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Id" }, "regularAssetTypeOptionOptionUnitOfMeasurementCode": { "title": "regularAssetTypeOptionOptionUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Code" }, "regularAssetTypeOptionOptionUnitOfMeasurementDescription": { "title": "regularAssetTypeOptionOptionUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_UnitOfMeasurement_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Notes" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->OptionValue" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_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" } } }, "GetRegularAssetOptionValueCollectionResourceActionResponse": { "title": "GetRegularAssetOptionValueCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetOptionValueCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetOptionValueCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Notes" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Description" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Id" }, "regularAssetTypeOptionOptionCode": { "title": "regularAssetTypeOptionOptionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Code" }, "regularAssetTypeOptionOptionDescription": { "title": "regularAssetTypeOptionOptionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Description" }, "regularAssetTypeOptionOptionDataType": { "title": "regularAssetTypeOptionOptionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_DataType", "x-formatSpecifier": "OptionDataType" }, "isCustom": { "title": "isCustom", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->IsCustom" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_Id" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_AllowMultipleValues" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Description" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Description" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->OptionValue" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetOptionValueForAssetCollectionResourceActionResponse": { "title": "GetRegularAssetOptionValueForAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetOptionValueForAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetOptionValueForAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->IsActive" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Description" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Id" }, "regularAssetTypeOptionOptionCode": { "title": "regularAssetTypeOptionOptionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Code" }, "regularAssetTypeOptionOptionDescription": { "title": "regularAssetTypeOptionOptionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Option_Description" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_Id" }, "optionOptionCategoryCode": { "title": "optionOptionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Code" }, "optionOptionCategoryDescription": { "title": "optionOptionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_OptionCategory_Description" }, "optionUnitOfMeasurementCode": { "title": "optionUnitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Code" }, "optionUnitOfMeasurementDescription": { "title": "optionUnitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_UnitOfMeasurement_Description" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionAllowMultipleValues": { "title": "optionAllowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_AllowMultipleValues" }, "optionCode": { "title": "optionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Code" }, "optionDescription": { "title": "optionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Description" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->OptionValue" }, "isCustom": { "title": "isCustom", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->IsCustom" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetOptionValue->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetOptionValueChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetOptionValueChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetOptionValueChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetOptionValueChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetOptionValueInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetOptionValueInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetOptionValueInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetOptionValueInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetOptionValueOptionLookupResourceActionResponse": { "title": "RegularAssetOptionValueOptionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetOptionValueOptionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetOptionValueOptionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Option->Description" }, "upperBounds": { "title": "upperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "lowerBounds": { "title": "lowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "Option->LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Option->DataType", "x-formatSpecifier": "OptionDataType" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Option->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Option->UnitOfMeasurement_Description" }, "optionCategoryId": { "title": "optionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Option->OptionCategory_Id" }, "optionCategoryCode": { "title": "optionCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Code" }, "optionCategoryDescription": { "title": "optionCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Option->OptionCategory_Description" }, "allowMultipleValues": { "title": "allowMultipleValues", "type": "boolean", "x-nullable": false, "x-propertyPath": "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" } } } }, "RegularAssetOptionValueRegularAssetLookupResourceActionResponse": { "title": "RegularAssetOptionValueRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetOptionValueRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetOptionValueRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponse": { "title": "RegularAssetOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetOptionValueRegularAssetTypeOptionForLinkedAssetTypeLookupResourceActionResponseItemProperties", "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" }, "optionUpperBounds": { "title": "optionUpperBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UpperBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionLowerBounds": { "title": "optionLowerBounds", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_LowerBounds", "x-NullExpression": "Option->DataType = 'String' OR Option->DataType = 'Boolean'" }, "optionDataType": { "title": "optionDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTypeOption->Option_DataType", "x-formatSpecifier": "OptionDataType" }, "optionUnitOfMeasurementId": { "title": "optionUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_UnitOfMeasurement_Id" }, "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" }, "optionOptionCategoryId": { "title": "optionOptionCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTypeOption->Option_OptionCategory_Id" }, "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" }, "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" } } } }, "CreateRegularAssetOptionValueResourceActionRequest": { "title": "CreateRegularAssetOptionValueResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetOptionValueResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "optionValue" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->SequenceNumber" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetOptionValue->RegularAsset_Id" }, "regularAssetTypeOptionId": { "title": "regularAssetTypeOptionId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetOptionValue->RegularAssetTypeOption_Id" }, "optionId": { "title": "optionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->Option_Id" }, "optionValue": { "title": "optionValue", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetOptionValue->OptionValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetOptionValueResourceActionRequest": { "title": "UpdateRegularAssetOptionValueResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetOptionValue->SequenceNumber" }, { "title": "optionValue", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->OptionValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetOptionValue->Notes" } ] } } }, "DeleteRegularAssetOptionValueResourceActionRequest": { "title": "DeleteRegularAssetOptionValueResourceActionRequest", "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 } } }, "BatchGetRegularAssetOptionValueResourceAction": { "title": "BatchGetRegularAssetOptionValueResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Option Value entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Option Value entities", "items": { "$ref": "#/definitions/GetRegularAssetOptionValueResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetOptionValueResourceActionRequest": { "title": "BatchCreateRegularAssetOptionValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetOptionValueResourceActionRequest" } }, "BatchUpdateRegularAssetOptionValueResourceActionRequest": { "title": "BatchUpdateRegularAssetOptionValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetOptionValueResourceActionRequest" } }, "BatchDeleteRegularAssetOptionValueResourceActionRequest": { "title": "BatchDeleteRegularAssetOptionValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetOptionValueResourceActionRequest" } }, "ChangeRegularAssetOptionValueIsActiveResourceActionRequest": { "title": "ChangeRegularAssetOptionValueIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetOptionValue->IsActive" } ] } } }, "BatchChangeRegularAssetOptionValueIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetOptionValueIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetOptionValueIsActiveResourceActionRequest" } }, "GetRegularAssetResponsibilityResourceActionResponse": { "title": "GetRegularAssetResponsibilityResourceActionResponse", "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": "GetRegularAssetResponsibilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetResponsibility->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetResponsibility->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetResponsibility->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetResponsibility->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->RecordType", "x-formatSpecifier": "AssetRecordType" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->RegularAsset_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Resource_Id", "x-NullExpression": "RegularAssetResponsibility->Section_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Resource_ContactDetailLastName" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Section_Id", "x-NullExpression": "RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Trade_Id", "x-NullExpression": "RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Section_Id eq NULL" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->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" } } }, "GetRegularAssetResponsibilityCollectionResourceActionResponse": { "title": "GetRegularAssetResponsibilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetResponsibilityCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetResponsibilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->IsActive" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->RegularAsset_Code" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Trade_Code" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Section_Code" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Resource_Code" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->InheritedFrom_Id" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetResponsibilityForRegularAssetCollectionResourceActionResponse": { "title": "GetRegularAssetResponsibilityForRegularAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetResponsibilityForRegularAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetResponsibilityForRegularAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Resource_Code" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Trade_Code" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Section_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->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" } } } }, "RegularAssetResponsibilityChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetResponsibilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetResponsibilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetResponsibilityChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetResponsibilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetResponsibilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetResponsibilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetResponsibilityRegularAssetLookupResourceActionResponse": { "title": "RegularAssetResponsibilityRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetResponsibilityRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetResponsibilityRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetResponsibilityResourceLookupResourceActionResponse": { "title": "RegularAssetResponsibilityResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetResponsibilityResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetResponsibilityResourceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponse": { "title": "RegularAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetResponsibilityResourceWithTradeFilterLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetResponsibilitySectionLookupResourceActionResponse": { "title": "RegularAssetResponsibilitySectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetResponsibilitySectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetResponsibilitySectionLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetResponsibilityTradeLookupResourceActionResponse": { "title": "RegularAssetResponsibilityTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetResponsibilityTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetResponsibilityTradeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetResponsibilityResourceActionRequest": { "title": "CreateRegularAssetResponsibilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetResponsibilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->PermissionTree_Id", "x-systemGenerated": true }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->RegularAsset_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Section_Id", "x-NullExpression": "RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Trade_Id", "x-NullExpression": "RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Section_Id eq NULL" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Resource_Id", "x-NullExpression": "RegularAssetResponsibility->Section_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetResponsibilityResourceActionRequest": { "title": "UpdateRegularAssetResponsibilityResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetResponsibility->SequenceNumber" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Section_Id", "x-NullExpression": "RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Trade_Id", "x-NullExpression": "RegularAssetResponsibility->Resource_Id eq NULL AND RegularAssetResponsibility->Section_Id eq NULL" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetResponsibility->Resource_Id", "x-NullExpression": "RegularAssetResponsibility->Section_Id eq NULL AND RegularAssetResponsibility->Trade_Id eq NULL" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetResponsibility->Notes" } ] } } }, "DeleteRegularAssetResponsibilityResourceActionRequest": { "title": "DeleteRegularAssetResponsibilityResourceActionRequest", "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 } } }, "BatchGetRegularAssetResponsibilityResourceAction": { "title": "BatchGetRegularAssetResponsibilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Responsibility entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Responsibility entities", "items": { "$ref": "#/definitions/GetRegularAssetResponsibilityResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetResponsibilityResourceActionRequest": { "title": "BatchCreateRegularAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetResponsibilityResourceActionRequest" } }, "BatchUpdateRegularAssetResponsibilityResourceActionRequest": { "title": "BatchUpdateRegularAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetResponsibilityResourceActionRequest" } }, "BatchDeleteRegularAssetResponsibilityResourceActionRequest": { "title": "BatchDeleteRegularAssetResponsibilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetResponsibilityResourceActionRequest" } }, "ChangeRegularAssetResponsibilityIsActiveResourceActionRequest": { "title": "ChangeRegularAssetResponsibilityIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetResponsibility->IsActive" } ] } } }, "ChangeRegularAssetResponsibilityPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetResponsibilityPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetResponsibility->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetResponsibilityIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetResponsibilityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetResponsibilityIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetResponsibilityPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetResponsibilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetResponsibilityPermissionTreeResourceActionRequest" } }, "GetRegularAssetSpareResourceActionResponse": { "title": "GetRegularAssetSpareResourceActionResponse", "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": "GetRegularAssetSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetSpare->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetSpare->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetSpare->InheritedFrom_LastConfirmedOn" }, "inheritedFromMaterialMasterId": { "title": "inheritedFromMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->InheritedFrom_MaterialMaster_Id" }, "inheritedFromMaterialMasterCode": { "title": "inheritedFromMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->InheritedFrom_MaterialMaster_Code" }, "inheritedFromMaterialMasterDescription": { "title": "inheritedFromMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->InheritedFrom_MaterialMaster_Description" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsEmergency" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->RecordType", "x-formatSpecifier": "AssetRecordType" }, "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->RegularAsset_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" } } }, "GetRegularAssetSpareCollectionResourceActionResponse": { "title": "GetRegularAssetSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->RegularAsset_Id" }, "regularAssetCode": { "title": "regularAssetCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->RegularAsset_Code" }, "regularAssetDescription": { "title": "regularAssetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->RegularAsset_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->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" } } } }, "GetSpareForRegularAssetCollectionResourceActionResponse": { "title": "GetSpareForRegularAssetCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForRegularAssetCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForRegularAssetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Description" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsEmergency" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsCritical" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->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" } } } }, "RegularAssetSpareChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetSpareMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetSpareRegularAssetLookupResourceActionResponse": { "title": "RegularAssetSpareRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetSpareRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetSpareRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetSpareResourceActionRequest": { "title": "CreateRegularAssetSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetId", "materialMasterId", "isCritical", "isEmergency" ], "properties": { "regularAssetId": { "title": "regularAssetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetSpare->RegularAsset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->PermissionTree_Id", "x-systemGenerated": true }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->SequenceNumber" }, "isCritical": { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsCritical" }, "isEmergency": { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsEmergency" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetSpareResourceActionRequest": { "title": "UpdateRegularAssetSpareResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetSpare->SequenceNumber" }, { "title": "isCritical", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsCritical" }, { "title": "isEmergency", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->IsEmergency" }, { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetSpare->MaterialMaster_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetSpare->Notes" } ] } } }, "DeleteRegularAssetSpareResourceActionRequest": { "title": "DeleteRegularAssetSpareResourceActionRequest", "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 } } }, "BatchGetRegularAssetSpareResourceAction": { "title": "BatchGetRegularAssetSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Spare entities", "items": { "$ref": "#/definitions/GetRegularAssetSpareResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetSpareResourceActionRequest": { "title": "BatchCreateRegularAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetSpareResourceActionRequest" } }, "BatchUpdateRegularAssetSpareResourceActionRequest": { "title": "BatchUpdateRegularAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetSpareResourceActionRequest" } }, "BatchDeleteRegularAssetSpareResourceActionRequest": { "title": "BatchDeleteRegularAssetSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetSpareResourceActionRequest" } }, "ChangeRegularAssetSpareIsActiveResourceActionRequest": { "title": "ChangeRegularAssetSpareIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetSpare->IsActive" } ] } } }, "ChangeRegularAssetSparePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetSparePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetSpare->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetSpareIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetSpareIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetSparePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetSparePermissionTreeResourceActionRequest" } }, "GetRegularAssetTaskResourceActionResponse": { "title": "GetRegularAssetTaskResourceActionResponse", "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": "GetRegularAssetTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->RulesLastEvaluatedOn" }, "unsubscribed": { "title": "unsubscribed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Unsubscribed" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->PermissionTree_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "assetAssetTypeId": { "title": "assetAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_AssetType_Id" }, "assetAssetTypeRecordType": { "title": "assetAssetTypeRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_AssetType_RecordType", "x-formatSpecifier": "AssetTypeRecordType" }, "assetNearestRegularAssetId": { "title": "assetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_NearestRegularAsset_Id" }, "assetTreePathId": { "title": "assetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_TreePathId" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Description" }, "componentQuantity": { "title": "componentQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Quantity" }, "componentTreePathId": { "title": "componentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_TreePathId" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Unsynchronised" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Site_Description" }, "actualInterval1": { "title": "actualInterval1", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ActualInterval1" }, "actualInterval2": { "title": "actualInterval2", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ActualInterval2" }, "allowConditions": { "title": "allowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AllowConditions" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, "assetTypeId": { "title": "assetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->AssetType_Id" }, "assetTypeCode": { "title": "assetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->AssetType_Code" }, "assetTypeDescription": { "title": "assetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->AssetType_Description" }, "autoCalculateDowntimePerUnit": { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDowntimePerUnit" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDowntime" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDuration" }, "daysToScheduleOn": { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Code" }, "defaultInterval1Description": { "title": "defaultInterval1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Description" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, "defaultInterval2Code": { "title": "defaultInterval2Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Code" }, "defaultInterval2Description": { "title": "defaultInterval2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Description" }, "derivedFromStandardTask": { "title": "derivedFromStandardTask", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DerivedFromStandardTask" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "detailEvaluationPassReason": { "title": "detailEvaluationPassReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->DetailEvaluationPassReason", "x-formatSpecifier": "RegularAssetTaskDetailEvalPassReason" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->DurationPerUnit" }, "estimatedNextDueDate": { "title": "estimatedNextDueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->EstimatedNextDueDate" }, "estimatedNextDueMeterReading": { "title": "estimatedNextDueMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->EstimatedNextDueMeterReading" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Event_Id" }, "eventCode": { "title": "eventCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Event_Code" }, "eventDescription": { "title": "eventDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Event_Description" }, "excludeWhenAllFollowUpTaskRulesFail": { "title": "excludeWhenAllFollowUpTaskRulesFail", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ExcludeWhenAllFollowUpTaskRulesFail" }, "excludeWhenAllSpareRulesFail": { "title": "excludeWhenAllSpareRulesFail", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ExcludeWhenAllSpareRulesFail" }, "excludeWhenSpecialResourceRulesFail": { "title": "excludeWhenSpecialResourceRulesFail", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ExcludeWhenSpecialResourceRulesFail" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTask->InspectionType eq 'PassOrFail'" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Id" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Importance_Code" }, "importanceDescription": { "title": "importanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Importance_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_Id" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_Description" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->InheritedFrom_LastConfirmedOn" }, "inheritedFromRecordType": { "title": "inheritedFromRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_RecordType", "x-formatSpecifier": "AssetTypeTaskRecordType" }, "inheritedFromAssetTypeId": { "title": "inheritedFromAssetTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_AssetType_Id" }, "inheritedFromAssetTypeCode": { "title": "inheritedFromAssetTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_AssetType_Code" }, "inheritedFromAssetTypeDescription": { "title": "inheritedFromAssetTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_AssetType_Description" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTask->IsInspection eq TRUE" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_Description" }, "intervalType1SchedulingKind": { "title": "intervalType1SchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Description" }, "intervalType2SchedulingKind": { "title": "intervalType2SchedulingKind", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_SchedulingKind", "x-formatSpecifier": "TaskSchedulingKind" }, "isDisabledByCondition": { "title": "isDisabledByCondition", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsDisabledByCondition" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsDualScheduling" }, "isInitialised": { "title": "isInitialised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsInitialised" }, "isInitialisedFailReasons": { "title": "isInitialisedFailReasons", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "IsInitialisedFailReason" }, "x-propertyPath": "RegularAssetTask->IsInitialisedFailReasons", "x-formatSpecifier": "IsInitialisedFailReason" }, "isInOpenWorkOrder": { "title": "isInOpenWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInOpenWorkOrder" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInspection" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsNonUsageBasedReadingRequired" }, "isPausedForScheduling": { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsPausedForScheduling" }, "isReadyForScheduling": { "title": "isReadyForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsReadyForScheduling" }, "isStatutory": { "title": "isStatutory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsStatutory" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsSuppressed" }, "isSuppressedErrors": { "title": "isSuppressedErrors", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "TaskSuppressionError" }, "x-propertyPath": "RegularAssetTask->IsSuppressedErrors", "x-formatSpecifier": "TaskSuppressionError" }, "isSuppressor": { "title": "isSuppressor", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsSuppressor" }, "isSuppressorErrors": { "title": "isSuppressorErrors", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "TaskSuppressionError" }, "x-propertyPath": "RegularAssetTask->IsSuppressorErrors", "x-formatSpecifier": "TaskSuppressionError" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "lastDoneCumulativeMeterReading": { "title": "lastDoneCumulativeMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastDoneCumulativeMeterReading" }, "lastScheduledServiceDate": { "title": "lastScheduledServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastScheduledServiceDate" }, "lastScheduledServiceMeterReading": { "title": "lastScheduledServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastScheduledServiceMeterReading" }, "lastServiceDate": { "title": "lastServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastServiceDate" }, "lastServiceMeterReading": { "title": "lastServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastServiceMeterReading" }, "latestWorkOrderTaskId": { "title": "latestWorkOrderTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_Id" }, "latestWorkOrderTaskAssetTreePathId": { "title": "latestWorkOrderTaskAssetTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_AssetTreePathId" }, "latestWorkOrderTaskAssetTreePathItems": { "title": "latestWorkOrderTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_AssetTreePathItems", "x-formatSpecifier": "TreePathItem" }, "latestWorkOrderTaskComponentTreePathId": { "title": "latestWorkOrderTaskComponentTreePathId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_ComponentTreePathId" }, "latestWorkOrderTaskComponentTreePathItems": { "title": "latestWorkOrderTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_ComponentTreePathItems", "x-formatSpecifier": "TreePathItem" }, "latestWorkOrderTaskCompleted": { "title": "latestWorkOrderTaskCompleted", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_Completed" }, "latestWorkOrderTaskTaskCode": { "title": "latestWorkOrderTaskTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_TaskCode" }, "latestWorkOrderTaskTaskDescription": { "title": "latestWorkOrderTaskTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_TaskDescription" }, "latestWorkOrderTaskTaskType": { "title": "latestWorkOrderTaskTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LatestWorkOrderTask_TaskType", "x-formatSpecifier": "EntityType" }, "longDescription": { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LongDescription" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MachineState", "x-formatSpecifier": "MachineState" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Description" }, "meterLastReadOn": { "title": "meterLastReadOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->Meter_LastReadOn" }, "meterLastReading": { "title": "meterLastReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_LastReading" }, "meterAverageDailyRate": { "title": "meterAverageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_AverageDailyRate" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPoint_Id", "x-NullExpression": "RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring'" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPoint_Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_Id", "x-NullExpression": "RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring'" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_Description" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Notes" }, "pausedReason": { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PausedReason", "x-NullExpression": "RegularAssetTask->IsPausedForScheduling eq TRUE" }, "printLongDescriptionOnWorkOrder": { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PrintLongDescriptionOnWorkOrder" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Id" }, "responsibleSectionCode": { "title": "responsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Code" }, "responsibleSectionDescription": { "title": "responsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Description" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_Id" }, "responsibleStaffMemberResourceCode": { "title": "responsibleStaffMemberResourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_Code" }, "responsibleStaffMemberResourceContactDetailId": { "title": "responsibleStaffMemberResourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailId" }, "responsibleStaffMemberResourceContactDetailFirstName": { "title": "responsibleStaffMemberResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailFirstName" }, "responsibleStaffMemberResourceContactDetailLastName": { "title": "responsibleStaffMemberResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_ContactDetailLastName" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Id" }, "responsibleTradeCode": { "title": "responsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Code" }, "responsibleTradeDescription": { "title": "responsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Description" }, "schedulingFailReasons": { "title": "schedulingFailReasons", "type": "array", "format": "enum", "x-nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "SchedulingFailReason" }, "x-propertyPath": "RegularAssetTask->SchedulingFailReasons", "x-formatSpecifier": "SchedulingFailReason" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification8_Description" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskRollUpPoint_Id" }, "taskRollUpPointCode": { "title": "taskRollUpPointCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskRollUpPoint_Code" }, "taskRollUpPointDescription": { "title": "taskRollUpPointDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskRollUpPoint_Description" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->TotalDuration" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->TypeOfWork_Id" }, "typeOfWorkCode": { "title": "typeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TypeOfWork_Code" }, "typeOfWorkDescription": { "title": "typeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->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" } } }, "GetDueTaskForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetDueTaskForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetDueTaskForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetDueTaskForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "generatedOn": { "title": "generatedOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "DueTask->GeneratedOn" }, "dueDate": { "title": "dueDate", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "DueTask->DueDate" }, "dueReading": { "title": "dueReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "DueTask->DueReading" }, "interval1DueDate": { "title": "interval1DueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTask->Interval1DueDate" }, "interval2DueDate": { "title": "interval2DueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "DueTask->Interval2DueDate" }, "isSuppressed": { "title": "isSuppressed", "type": "boolean", "x-nullable": true, "x-propertyPath": "DueTask->IsSuppressed" }, "outOfBoundsTask": { "title": "outOfBoundsTask", "type": "boolean", "x-nullable": true, "x-propertyPath": "DueTask->OutOfBoundsTask" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInspection" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->InheritedFrom_Id" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsDualScheduling" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Notes" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SequenceNumber" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_Description" }, "assetTreePathItems": { "title": "assetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "componentCode": { "title": "componentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Code" }, "componentDescription": { "title": "componentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_Description" }, "componentRecordType": { "title": "componentRecordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "componentTreePathItems": { "title": "componentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTask->Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "defaultInterval1Code": { "title": "defaultInterval1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Code" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDuration" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDowntime" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTask->RulesLastEvaluatedOn" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Importance_Id" }, "importanceCode": { "title": "importanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Code" }, "importanceDescription": { "title": "importanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Description" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->RuleEvaluationPassed" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Site_Id" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, "intervalType1Code": { "title": "intervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Code" }, "intervalType1Description": { "title": "intervalType1Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Description" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, "intervalType2Code": { "title": "intervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Code" }, "intervalType2Description": { "title": "intervalType2Description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType2_Description" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsNonUsageBasedReadingRequired" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskAssetComponentFromAssetLookupResourceActionResponse": { "title": "StandardTaskAssetComponentFromAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAssetComponentFromAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAssetComponentFromAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskAssetComponentLookupResourceActionResponse": { "title": "StandardTaskAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Asset_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "StandardTaskAssetLookupResourceActionResponse": { "title": "StandardTaskAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "StandardTaskAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "StandardTaskAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskDefaultInterval1LookupResourceActionResponse": { "title": "RegularAssetTaskDefaultInterval1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskDefaultInterval1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskDefaultInterval1LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskDefaultInterval2LookupResourceActionResponse": { "title": "RegularAssetTaskDefaultInterval2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskDefaultInterval2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskDefaultInterval2LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskEventLookupResourceActionResponse": { "title": "RegularAssetTaskEventLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskEventLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskEventLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskImportanceLookupResourceActionResponse": { "title": "RegularAssetTaskImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskImportanceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskImportanceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskIntervalType1LookupResourceActionResponse": { "title": "RegularAssetTaskIntervalType1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskIntervalType1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskIntervalType1LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskIntervalType2LookupResourceActionResponse": { "title": "RegularAssetTaskIntervalType2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskIntervalType2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskIntervalType2LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskMeterAllLookupResourceActionResponse": { "title": "RegularAssetTaskMeterAllLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskMeterAllLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskMeterAllLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskMeterLookupResourceActionResponse": { "title": "RegularAssetTaskMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskMeterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskMonitoringPointLookupResourceActionResponse": { "title": "RegularAssetTaskMonitoringPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskMonitoringPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskMonitoringPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPoint->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskMonitoringPointTypeLookupResourceActionResponse": { "title": "RegularAssetTaskMonitoringPointTypeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskMonitoringPointTypeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskMonitoringPointTypeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskRegularAssetComponentLookupResourceActionResponse": { "title": "RegularAssetTaskRegularAssetComponentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskRegularAssetComponentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskRegularAssetComponentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AssetComponent->Description" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetComponent->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" } } } }, "RegularAssetTaskRegularAssetLookupResourceActionResponse": { "title": "RegularAssetTaskRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAsset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAsset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskResponsibleSectionLookupResourceActionResponse": { "title": "RegularAssetTaskResponsibleSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResponsibleSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResponsibleSectionLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponse": { "title": "RegularAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResponsibleStaffMemberResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskResponsibleTradeLookupResourceActionResponse": { "title": "RegularAssetTaskResponsibleTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResponsibleTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResponsibleTradeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSiteLookupResourceActionResponse": { "title": "RegularAssetTaskSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSiteLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskTaskClassification1LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification1LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification1LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification1LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskClassification2LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification2LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification2LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification2LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskClassification3LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification3LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification3LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification3LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskClassification4LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification4LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification4LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification4LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskClassification5LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification5LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification5LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification5LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskClassification6LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification6LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification6LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification6LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskClassification7LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification7LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification7LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification7LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskClassification8LookupResourceActionResponse": { "title": "RegularAssetTaskTaskClassification8LookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskClassification8LookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskClassification8LookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTaskRollUpPointLookupResourceActionResponse": { "title": "RegularAssetTaskTaskRollUpPointLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTaskRollUpPointLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTaskRollUpPointLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskTypeOfWorkLookupResourceActionResponse": { "title": "RegularAssetTaskTypeOfWorkLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskTypeOfWorkLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskTypeOfWorkLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTaskResourceActionRequest": { "title": "CreateRegularAssetTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetId", "autoCalculateDowntimePerUnit", "autoCalculateTotalDowntime", "autoCalculateDurationPerUnit", "autoCalculateTotalDuration", "description", "importanceId", "intervalType1Id", "isDualScheduling", "isInspection", "isMandatory", "isNonUsageBasedReadingRequired", "isStatutory", "labourDurationCalculationType", "motionType", "typeOfWorkId" ], "properties": { "allowConditions": { "title": "allowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AllowConditions" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, "autoCalculateDowntimePerUnit": { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDowntimePerUnit" }, "autoCalculateTotalDowntime": { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDowntime" }, "autoCalculateDurationPerUnit": { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDurationPerUnit" }, "autoCalculateTotalDuration": { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDuration" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code", "x-systemGenerated": true }, "componentId": { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, "daysToScheduleOn": { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, "defaultInterval1Id": { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, "defaultInterval2Id": { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "downtimePerUnit": { "title": "downtimePerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->DowntimePerUnit" }, "durationPerUnit": { "title": "durationPerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->DurationPerUnit" }, "eventId": { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Event_Id" }, "failedReasonRequired": { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTask->InspectionType eq 'PassOrFail'" }, "importanceId": { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Id" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, "intervalType2Id": { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, "isDualScheduling": { "title": "isDualScheduling", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsDualScheduling" }, "isInspection": { "title": "isInspection", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInspection" }, "inspectionType": { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTask->IsInspection eq TRUE" }, "isMandatory": { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, "isNonUsageBasedReadingRequired": { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsNonUsageBasedReadingRequired" }, "isStatutory": { "title": "isStatutory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsStatutory" }, "isPausedForScheduling": { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsPausedForScheduling" }, "labourDurationCalculationType": { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, "longDescription": { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LongDescription" }, "machineState": { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MachineState", "x-formatSpecifier": "MachineState" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Id" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPoint_Id", "x-NullExpression": "RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring'" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_Id", "x-NullExpression": "RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring'" }, "motionType": { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MotionType", "x-formatSpecifier": "MotionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Notes" }, "pausedReason": { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PausedReason", "x-NullExpression": "RegularAssetTask->IsPausedForScheduling eq TRUE" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Site_Id", "x-systemGenerated": true }, "printLongDescriptionOnWorkOrder": { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PrintLongDescriptionOnWorkOrder" }, "responsibleStaffMemberResourceId": { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_Id" }, "responsibleSectionId": { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Id" }, "responsibleTradeId": { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Id" }, "schedulingMethod": { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SequenceNumber" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification1_Id" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification2_Id" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification3_Id" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification4_Id" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification5_Id" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification6_Id" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification7_Id" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification8_Id" }, "taskRollUpPointId": { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTask->TaskRollUpPoint_Id" }, "totalDowntime": { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->TotalDowntime" }, "totalDuration": { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->TotalDuration" }, "typeOfWorkId": { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->TypeOfWork_Id" }, "lastServiceDate": { "title": "lastServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastServiceDate" }, "lastScheduledServiceDate": { "title": "lastScheduledServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastScheduledServiceDate" }, "lastServiceMeterReading": { "title": "lastServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastServiceMeterReading" }, "lastScheduledServiceMeterReading": { "title": "lastScheduledServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastScheduledServiceMeterReading" }, "lastDoneCumulativeMeterReading": { "title": "lastDoneCumulativeMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastDoneCumulativeMeterReading" }, "estimatedNextDueMeterReading": { "title": "estimatedNextDueMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->EstimatedNextDueMeterReading" }, "estimatedNextDueDate": { "title": "estimatedNextDueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->EstimatedNextDueDate" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskResourceActionRequest": { "title": "UpdateRegularAssetTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "allowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AllowConditions" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, { "title": "assetId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTask->Asset_Id" }, { "title": "autoCalculateDowntimePerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDowntimePerUnit" }, { "title": "autoCalculateDurationPerUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateDurationPerUnit" }, { "title": "autoCalculateTotalDowntime", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDowntime" }, { "title": "autoCalculateTotalDuration", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->AutoCalculateTotalDuration" }, { "title": "code", "type": "string", "readOnly": true, "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code", "x-ReadOnlyExpression": "RegularAssetTask->IsInherited eq true" }, { "title": "componentId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTask->Component_Id" }, { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, { "title": "description", "type": "string", "readOnly": true, "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description", "x-ReadOnlyExpression": "RegularAssetTask->IsInherited eq true" }, { "title": "downtimePerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->DowntimePerUnit" }, { "title": "durationPerUnit", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->DurationPerUnit" }, { "title": "failedReasonRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->FailedReasonRequired", "x-NullExpression": "RegularAssetTask->InspectionType eq 'PassOrFail'" }, { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Id" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->TypeOfWork_Id" }, { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Event_Id" }, { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, { "title": "isDualScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsDualScheduling" }, { "title": "isInspection", "type": "boolean", "readOnly": true, "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsInspection", "x-ReadOnlyExpression": "RegularAssetTask->IsInherited eq TRUE" }, { "title": "inspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTask->IsInspection eq TRUE" }, { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, { "title": "isNonUsageBasedReadingRequired", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsNonUsageBasedReadingRequired" }, { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsPausedForScheduling" }, { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MachineState", "x-formatSpecifier": "MachineState" }, { "title": "monitoringPointId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPoint_Id", "x-NullExpression": "RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring'" }, { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_Id", "x-NullExpression": "RegularAssetTask->InspectionType ne 'ManualReadingOnly' AND RegularAssetTask->InspectionType ne 'ManualMonitoring'" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "isStatutory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsStatutory" }, { "title": "labourDurationCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->LabourDurationCalculationType", "x-formatSpecifier": "LabourDurationCalculationType" }, { "title": "longDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LongDescription" }, { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Notes" }, { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PausedReason", "x-NullExpression": "RegularAssetTask->IsPausedForScheduling eq TRUE" }, { "title": "printLongDescriptionOnWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PrintLongDescriptionOnWorkOrder" }, { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_Id" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Id" }, { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Id" }, { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SequenceNumber" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification8_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTask->TaskRollUpPoint_Id" }, { "title": "totalDowntime", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->TotalDowntime" }, { "title": "totalDuration", "type": "string", "format": "duration", "minimum": 0.0, "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "RegularAssetTask->TotalDuration" }, { "title": "lastServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastServiceDate" }, { "title": "lastScheduledServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastScheduledServiceDate" }, { "title": "lastServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastServiceMeterReading" }, { "title": "lastScheduledServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastScheduledServiceMeterReading" }, { "title": "lastDoneCumulativeMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastDoneCumulativeMeterReading" }, { "title": "estimatedNextDueMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->EstimatedNextDueMeterReading" }, { "title": "estimatedNextDueDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->EstimatedNextDueDate" } ] } } }, "DeleteRegularAssetTaskResourceActionRequest": { "title": "DeleteRegularAssetTaskResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskResourceAction": { "title": "BatchGetRegularAssetTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskResourceActionRequest" } }, "BatchDeleteRegularAssetTaskResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskResourceActionRequest" } }, "BatchCheckIsInitialisedBulkResourceActionRequest": { "title": "BatchCheckIsInitialisedBulkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchCheckIsInitialisedBulkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchCheckIsReadyForSchedulingBulkResourceActionRequest": { "title": "BatchCheckIsReadyForSchedulingBulkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchCheckIsReadyForSchedulingBulkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchGenerateDueTasksForRegularAssetTasksBulkResourceActionRequest": { "title": "BatchGenerateDueTasksForRegularAssetTasksBulkResourceActionRequest", "type": "object", "properties": { "properties": { "title": "BatchGenerateDueTasksForRegularAssetTasksBulkResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeRegularAssetTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTask->IsActive" } ] } } }, "ChangeRegularAssetTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTask->PermissionTree_Id" } ] } } }, "CreateRegularAssetTaskFromStandardTaskResourceActionRequest": { "title": "CreateRegularAssetTaskFromStandardTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskFromStandardTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetId", "standardTaskIds" ], "properties": { "assetId": { "title": "assetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CreateRegularAssetTaskFromStandardTask->Asset_Id" }, "assetComponentId": { "title": "assetComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTaskFromStandardTask->AssetComponent_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTaskFromStandardTask->PermissionTree_Id", "x-systemGenerated": true }, "breakStandardTaskLink": { "title": "breakStandardTaskLink", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTaskFromStandardTask->BreakStandardTaskLink" }, "keepStandardTaskCode": { "title": "keepStandardTaskCode", "type": "boolean", "x-nullable": true, "x-propertyPath": "CreateRegularAssetTaskFromStandardTask->KeepStandardTaskCode" }, "standardTaskIds": { "title": "standardTaskIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "CreateRegularAssetTaskFromStandardTask->StandardTaskIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ResubscribeRegularAssetTaskDevelopmentStatusResourceActionRequest": { "title": "ResubscribeRegularAssetTaskDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ResubscribeRegularAssetTaskDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UnsubscribeRegularAssetTaskDevelopmentStatusResourceActionRequest": { "title": "UnsubscribeRegularAssetTaskDevelopmentStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "UnsubscribeRegularAssetTaskDevelopmentStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "ids" ], "properties": { "ids": { "title": "ids", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "IdListEntity->Ids", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeRegularAssetTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskPermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTaskResourceActionRequest": { "title": "MatchUpdateRegularAssetTaskResourceActionRequest", "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": "RegularAssetTask->AllowConditions" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTask->AlternativeDescription" }, { "title": "daysToScheduleOn", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DaysToScheduleOn", "x-formatSpecifier": "DaysToScheduleOn" }, { "title": "defaultInterval1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval1_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, { "title": "defaultInterval2Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->DefaultInterval2_Id", "x-NullExpression": "RegularAssetTask->IsDualScheduling eq TRUE" }, { "title": "importanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Importance_Id" }, { "title": "typeOfWorkId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->TypeOfWork_Id" }, { "title": "eventId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Event_Id" }, { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, { "title": "intervalType2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType2_Id" }, { "title": "isDualScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsDualScheduling" }, { "title": "isMandatory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsMandatory" }, { "title": "isPausedForScheduling", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IsPausedForScheduling" }, { "title": "motionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MotionType", "x-formatSpecifier": "MotionType" }, { "title": "machineState", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTask->MachineState", "x-formatSpecifier": "MachineState" }, { "title": "isStatutory", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTask->IsStatutory" }, { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Meter_Id" }, { "title": "pausedReason", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->PausedReason", "x-NullExpression": "RegularAssetTask->IsPausedForScheduling eq TRUE" }, { "title": "responsibleStaffMemberResourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleStaffMemberResource_Id" }, { "title": "responsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleSection_Id" }, { "title": "responsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->ResponsibleTrade_Id" }, { "title": "schedulingMethod", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SchedulingMethod", "x-formatSpecifier": "TaskSchedulingMethod" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTask->SequenceNumber" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->TaskClassification8_Id" }, { "title": "taskRollUpPointId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTask->TaskRollUpPoint_Id" }, { "title": "lastServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastServiceDate" }, { "title": "lastServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastServiceMeterReading" }, { "title": "lastScheduledServiceMeterReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTask->LastScheduledServiceMeterReading" }, { "title": "lastScheduledServiceDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "RegularAssetTask->LastScheduledServiceDate" } ] } } }, "GetRegularAssetTaskAttributeResourceActionResponse": { "title": "GetRegularAssetTaskAttributeResourceActionResponse", "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": "GetRegularAssetTaskAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->InheritedFrom" }, "inheritedFromStandardTaskAttribute": { "title": "inheritedFromStandardTaskAttribute", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->InheritedFromStandardTaskAttribute" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->RegularAssetTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->SynchronisedWithTypeObjectUpTo" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->IsHistorical" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Unsynchronised" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->IsInherited" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->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" } } }, "GetRegularAssetTaskAttributeCollectionForRegularAssetTaskResourceActionResponse": { "title": "GetRegularAssetTaskAttributeCollectionForRegularAssetTaskResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskAttributeCollectionForRegularAssetTaskResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskAttributeCollectionForRegularAssetTaskResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->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" } } } }, "GetRegularAssetTaskAttributeCollectionResourceActionResponse": { "title": "GetRegularAssetTaskAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskAttributeCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->RegularAssetTask_Description" }, "regularAssetTaskAlternativeDescription": { "title": "regularAssetTaskAlternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->RegularAssetTask_AlternativeDescription" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->IsInherited" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAttribute->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" } } } }, "RegularAssetTaskAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "RegularAssetTaskAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskAttributeAttributeLookupResourceActionResponse": { "title": "RegularAssetTaskAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAttributeAttributeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskAttributeRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskAttributeRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAttributeRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAttributeRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTaskAttributeResourceActionRequest": { "title": "CreateRegularAssetTaskAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "attributeId" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->RegularAssetTask_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskAttributeResourceActionRequest": { "title": "UpdateRegularAssetTaskAttributeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAttribute->Notes" } ] } } }, "DeleteRegularAssetTaskAttributeResourceActionRequest": { "title": "DeleteRegularAssetTaskAttributeResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskAttributeResourceAction": { "title": "BatchGetRegularAssetTaskAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Attribute entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskAttributeResourceActionRequest": { "title": "BatchCreateRegularAssetTaskAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskAttributeResourceActionRequest" } }, "BatchUpdateRegularAssetTaskAttributeResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskAttributeResourceActionRequest" } }, "BatchDeleteRegularAssetTaskAttributeResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskAttributeResourceActionRequest" } }, "ChangeRegularAssetTaskAttributeIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskAttributeIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskAttribute->IsActive" } ] } } }, "ChangeRegularAssetTaskAttributePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskAttributePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskAttribute->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskAttributeIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskAttributeIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskAttributePermissionTreeResourceActionRequest" } }, "GetRegularAssetTaskAuxiliaryTaskResourceActionResponse": { "title": "GetRegularAssetTaskAuxiliaryTaskResourceActionResponse", "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": "GetRegularAssetTaskAuxiliaryTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->PermissionTree_Description" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_LastConfirmedOn" }, "inheritedFromAuxiliaryTaskId": { "title": "inheritedFromAuxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Id" }, "inheritedFromAuxiliaryTaskCode": { "title": "inheritedFromAuxiliaryTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_AuxiliaryTask_Code" }, "inheritedFromRegularAssetTypeTaskId": { "title": "inheritedFromRegularAssetTypeTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Id" }, "inheritedFromRegularAssetTypeTaskCode": { "title": "inheritedFromRegularAssetTypeTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_RegularAssetTypeTask_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->Notes" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRegularAssetTaskAuxiliaryTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskAuxiliaryTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskAuxiliaryTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskAuxiliaryTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Description" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->InheritedFrom_LastConfirmedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->Unsynchronised" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskAuxiliaryTask->LastConfirmedOn" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTaskAuxiliaryTaskForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskAuxiliaryTaskForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskAuxiliaryTaskForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskAuxiliaryTaskForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id" }, "auxiliaryTaskCode": { "title": "auxiliaryTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Code" }, "auxiliaryTaskDescription": { "title": "auxiliaryTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->IsInherited" }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponse": { "title": "RegularAssetTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAuxiliaryTaskAuxiliaryTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AuxiliaryAssetTask->Description" }, "auxiliaryTaskType": { "title": "auxiliaryTaskType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->AuxiliaryTaskType", "x-formatSpecifier": "AuxiliaryTaskType" }, "assetNearestRegularAssetId": { "title": "assetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AuxiliaryAssetTask->Asset_NearestRegularAsset_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" } } } }, "RegularAssetTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAuxiliaryTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAuxiliaryTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskAuxiliaryTaskRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskAuxiliaryTaskRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskAuxiliaryTaskRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskAuxiliaryTaskRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "assetNearestRegularAssetId": { "title": "assetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_NearestRegularAsset_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" } } } }, "CreateRegularAssetTaskAuxiliaryTaskResourceActionRequest": { "title": "CreateRegularAssetTaskAuxiliaryTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskAuxiliaryTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "auxiliaryTaskId", "auxiliaryType" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->RegularAssetTask_Id" }, "auxiliaryTaskId": { "title": "auxiliaryTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->PermissionTree_Id", "x-systemGenerated": true }, "auxiliaryType": { "title": "auxiliaryType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskAuxiliaryTaskResourceActionRequest": { "title": "UpdateRegularAssetTaskAuxiliaryTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskAuxiliaryTask->AuxiliaryType", "x-formatSpecifier": "AuxiliaryTaskType" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskAuxiliaryTask->Notes" } ] } } }, "DeleteRegularAssetTaskAuxiliaryTaskResourceActionRequest": { "title": "DeleteRegularAssetTaskAuxiliaryTaskResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskAuxiliaryTaskResourceAction": { "title": "BatchGetRegularAssetTaskAuxiliaryTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Auxiliary Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Auxiliary Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskAuxiliaryTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskAuxiliaryTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTaskAuxiliaryTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTaskAuxiliaryTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskAuxiliaryTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, "BatchDeleteRegularAssetTaskAuxiliaryTaskResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskAuxiliaryTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskAuxiliaryTaskResourceActionRequest" } }, "ChangeRegularAssetTaskAuxiliaryTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskAuxiliaryTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskAuxiliaryTask->IsActive" } ] } } }, "ChangeRegularAssetTaskAuxiliaryTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskAuxiliaryTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskAuxiliaryTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskAuxiliaryTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskAuxiliaryTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskAuxiliaryTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskAuxiliaryTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskAuxiliaryTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskAuxiliaryTaskPermissionTreeResourceActionRequest" } }, "GetRegularAssetTaskConditionResourceActionResponse": { "title": "GetRegularAssetTaskConditionResourceActionResponse", "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": "GetRegularAssetTaskConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->PermissionTree_Description" }, "activeCondition": { "title": "activeCondition", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ActiveCondition" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_Description" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_LastConfirmedOn" }, "inheritedFromConditionId": { "title": "inheritedFromConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Condition_Id" }, "inheritedFromConditionCode": { "title": "inheritedFromConditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Condition_Code" }, "inheritedFromConditionDescription": { "title": "inheritedFromConditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Condition_Description" }, "inheritedFromConditionConditionTypeId": { "title": "inheritedFromConditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Id" }, "inheritedFromConditionConditionTypeCode": { "title": "inheritedFromConditionConditionTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Code" }, "inheritedFromConditionConditionTypeDescription": { "title": "inheritedFromConditionConditionTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Condition_ConditionType_Description" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Id" }, "intervalCode": { "title": "intervalCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Code" }, "intervalDescription": { "title": "intervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Notes" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Description" }, "regularAssetTaskIntervalType1Id": { "title": "regularAssetTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->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" } } }, "GetConditionForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetConditionForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetConditionForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetConditionForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->IsInherited" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Description" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->IsActive" }, "activeCondition": { "title": "activeCondition", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ActiveCondition" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTaskConditionCollectionResourceActionResponse": { "title": "GetRegularAssetTaskConditionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskConditionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Description" }, "regularAssetTaskIntervalType1Id": { "title": "regularAssetTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_Id" }, "conditionConditionTypeId": { "title": "conditionConditionTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Id" }, "conditionConditionTypeCode": { "title": "conditionConditionTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Code" }, "conditionConditionTypeDescription": { "title": "conditionConditionTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_ConditionType_Description" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Description" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->InheritedFrom_LastConfirmedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Unsynchronised" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskCondition->LastConfirmedOn" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Id" }, "intervalCode": { "title": "intervalCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Interval_Code" }, "intervalDescription": { "title": "intervalDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Description" }, "activeCondition": { "title": "activeCondition", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ActiveCondition" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTaskConditionsRecursiveForParentResourceActionResponse": { "title": "GetRegularAssetTaskConditionsRecursiveForParentResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskConditionsRecursiveForParentResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskConditionsRecursiveForParentResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Id" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Asset_Id" }, "regularAssetTaskAssetCode": { "title": "regularAssetTaskAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Asset_Code" }, "regularAssetTaskAssetDescription": { "title": "regularAssetTaskAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Asset_Description" }, "regularAssetTaskAssetTreePathItems": { "title": "regularAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskComponentId": { "title": "regularAssetTaskComponentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Component_Id" }, "regularAssetTaskComponentCode": { "title": "regularAssetTaskComponentCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Component_Code" }, "regularAssetTaskComponentDescription": { "title": "regularAssetTaskComponentDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Component_Description" }, "regularAssetTaskComponentTreePathItems": { "title": "regularAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskVersion": { "title": "regularAssetTaskVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Version" }, "regularAssetTaskPermissionTreeId": { "title": "regularAssetTaskPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_PermissionTree_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Description" }, "regularAssetTaskIntervalType1Id": { "title": "regularAssetTaskIntervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Id" }, "regularAssetTaskIntervalType1Code": { "title": "regularAssetTaskIntervalType1Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_IntervalType1_Code" }, "regularAssetTaskIntervalType2Code": { "title": "regularAssetTaskIntervalType2Code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_IntervalType2_Code" }, "regularAssetTaskActualInterval1": { "title": "regularAssetTaskActualInterval1", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_ActualInterval1" }, "regularAssetTaskActualInterval2": { "title": "regularAssetTaskActualInterval2", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_ActualInterval2" }, "regularAssetTaskAllowConditions": { "title": "regularAssetTaskAllowConditions", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_AllowConditions" }, "regularAssetTaskIsDisabledByCondition": { "title": "regularAssetTaskIsDisabledByCondition", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_IsDisabledByCondition" }, "regularAssetTaskMotionType": { "title": "regularAssetTaskMotionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_MotionType", "x-formatSpecifier": "MotionType" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->State", "x-formatSpecifier": "ConditionState" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor" }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Condition_Id" }, "conditionCode": { "title": "conditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Code" }, "conditionDescription": { "title": "conditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Description" }, "activeCondition": { "title": "activeCondition", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->ActiveCondition" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskConditionAllTaskIntervalLookupRResponse": { "title": "RegularAssetTaskConditionAllTaskIntervalLookupRResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskConditionAllTaskIntervalLookupRResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskConditionAllTaskIntervalLookupRResponseItemProperties", "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" } } } }, "RegularAssetTaskConditionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskConditionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskConditionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskConditionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskConditionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskConditionRegularAssetConditionLookupResourceActionResponse": { "title": "RegularAssetTaskConditionRegularAssetConditionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskConditionRegularAssetConditionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskConditionRegularAssetConditionLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskConditionRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskConditionRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskConditionRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskConditionRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "intervalType1Id": { "title": "intervalType1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->IntervalType1_Id" }, "assetNearestRegularAssetId": { "title": "assetNearestRegularAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->Asset_NearestRegularAsset_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" } } } }, "RegularAssetTaskConditionTaskIntervalLookupResourceActionResponse": { "title": "RegularAssetTaskConditionTaskIntervalLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskConditionTaskIntervalLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskConditionTaskIntervalLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTaskConditionResourceActionRequest": { "title": "CreateRegularAssetTaskConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "conditionId" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskCondition->RegularAssetTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->SequenceNumber" }, "adjustmentFactor": { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor", "x-systemGenerated": true }, "conditionId": { "title": "conditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskCondition->Condition_Id" }, "state": { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->State", "x-systemGenerated": true, "x-formatSpecifier": "ConditionState" }, "intervalId": { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskConditionResourceActionRequest": { "title": "UpdateRegularAssetTaskConditionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskCondition->SequenceNumber" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor" }, { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Id" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Notes" } ] } } }, "DeleteRegularAssetTaskConditionResourceActionRequest": { "title": "DeleteRegularAssetTaskConditionResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskConditionResourceAction": { "title": "BatchGetRegularAssetTaskConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Condition entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Condition entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskConditionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskConditionResourceActionRequest": { "title": "BatchCreateRegularAssetTaskConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskConditionResourceActionRequest" } }, "BatchUpdateRegularAssetTaskConditionResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskConditionResourceActionRequest" } }, "BatchDeleteRegularAssetTaskConditionResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskConditionResourceActionRequest" } }, "ChangeRegularAssetTaskConditionIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskConditionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskCondition->IsActive" } ] } } }, "ChangeRegularAssetTaskConditionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskConditionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskCondition->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskConditionIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskConditionIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskConditionPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskConditionPermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTaskConditionResourceActionRequest": { "title": "MatchUpdateRegularAssetTaskConditionResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->SequenceNumber" }, { "title": "adjustmentFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->AdjustmentFactor" }, { "title": "intervalId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Interval_Id" }, { "title": "state", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->State", "x-formatSpecifier": "ConditionState" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskCondition->Notes" } ] } } }, "GetRegularAssetTaskDocumentResourceActionResponse": { "title": "GetRegularAssetTaskDocumentResourceActionResponse", "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": "GetRegularAssetTaskDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "inheritedFrom": { "title": "inheritedFrom", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->InheritedFrom" }, "inheritedFromStandardTaskDocument": { "title": "inheritedFromStandardTaskDocument", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->InheritedFromStandardTaskDocument" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->RegularAssetTask_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->LastConfirmedOn" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->Unsynchronised" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->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" } } }, "GetRegularAssetTaskDocumentCollectionForRegularAssetTaskResourceActionResponse": { "title": "GetRegularAssetTaskDocumentCollectionForRegularAssetTaskResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskDocumentCollectionForRegularAssetTaskResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskDocumentCollectionForRegularAssetTaskResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->IsInherited" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->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" } } } }, "GetRegularAssetTaskDocumentCollectionResourceActionResponse": { "title": "GetRegularAssetTaskDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskDocumentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->RegularAssetTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->IsInherited" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskDocument->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" } } } }, "RegularAssetTaskDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskDocumentDocumentLookupResourceActionResponse": { "title": "RegularAssetTaskDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskDocumentDocumentLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskDocumentRegularAssetLookupResourceActionResponse": { "title": "RegularAssetTaskDocumentRegularAssetLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskDocumentRegularAssetLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskDocumentRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTaskDocumentResourceActionRequest": { "title": "CreateRegularAssetTaskDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "documentRecordId" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->RegularAssetTask_Id" }, "copyDocumentLink": { "title": "copyDocumentLink", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskDocumentResourceActionRequest": { "title": "UpdateRegularAssetTaskDocumentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskDocument->CopyDocumentLink", "x-formatSpecifier": "CopyDocumentLink" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskDocument->Notes" } ] } } }, "DeleteRegularAssetTaskDocumentResourceActionRequest": { "title": "DeleteRegularAssetTaskDocumentResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskDocumentResourceAction": { "title": "BatchGetRegularAssetTaskDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Document entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskDocumentResourceActionRequest": { "title": "BatchCreateRegularAssetTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskDocumentResourceActionRequest" } }, "BatchUpdateRegularAssetTaskDocumentResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskDocumentResourceActionRequest" } }, "BatchDeleteRegularAssetTaskDocumentResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskDocumentResourceActionRequest" } }, "ChangeRegularAssetTaskDocumentIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskDocumentIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskDocument->IsActive" } ] } } }, "ChangeRegularAssetTaskDocumentPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskDocumentPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskDocument->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskDocumentIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskDocumentIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskDocumentPermissionTreeResourceActionRequest" } }, "GetRegularAssetTaskFileAttachmentResourceActionResponse": { "title": "GetRegularAssetTaskFileAttachmentResourceActionResponse", "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": "GetRegularAssetTaskFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "RegularAssetTaskFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->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" } } }, "GetRegularAssetTaskFileAttachmentCollectionForRegularAssetTaskResourceActionResponse": { "title": "GetRegularAssetTaskFileAttachmentCollectionForRegularAssetTaskResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskFileAttachmentCollectionForRegularAssetTaskResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskFileAttachmentCollectionForRegularAssetTaskResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFileAttachment->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" } } } }, "GetRegularAssetTaskFileAttachmentCollectionResourceActionResponse": { "title": "GetRegularAssetTaskFileAttachmentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskFileAttachmentCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFileAttachment->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" } } } }, "CreateRegularAssetTaskFileAttachmentResourceActionRequest": { "title": "CreateRegularAssetTaskFileAttachmentResourceActionRequest", "type": "object", "required": [ "regularAssetTaskId" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateRegularAssetTaskFileAttachmentContentResourceActionRequest": { "title": "UpdateRegularAssetTaskFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateRegularAssetTaskFileAttachmentResourceActionRequest": { "title": "UpdateRegularAssetTaskFileAttachmentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->IsRestricted" } ] } } }, "DeleteRegularAssetTaskFileAttachmentResourceResourceActionRequest": { "title": "DeleteRegularAssetTaskFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskFileAttachmentResourceAction": { "title": "BatchGetRegularAssetTaskFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task File Attachment entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskFileAttachmentResourceActionResponse" } }, "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" } } }, "GetRegularAssetTaskFileAttachmentContentHistoryResourceActionResponse": { "title": "GetRegularAssetTaskFileAttachmentContentHistoryResourceActionResponse", "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" } } }, "GetRegularAssetTaskFileAttachmentContentHistoryResourceAction": { "title": "GetRegularAssetTaskFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task File Attachment entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskFileAttachmentResourceActionRequest": { "title": "BatchCreateRegularAssetTaskFileAttachmentResourceActionRequest", "type": "object", "required": [ "regularAssetTaskId" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->RegularAssetTask_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateRegularAssetTaskFileAttachmentResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskFileAttachmentResourceActionRequest" } }, "BatchDeleteRegularAssetTaskFileAttachmentResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskFileAttachmentResourceResourceActionRequest" } }, "GetRegularAssetTaskFollowUpTaskResourceActionResponse": { "title": "GetRegularAssetTaskFollowUpTaskResourceActionResponse", "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": "GetRegularAssetTaskFollowUpTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->PermissionTree_Description" }, "addToWorkOrder": { "title": "addToWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->AddToWorkOrder" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->InheritedFrom_LastConfirmedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->Notes" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Description" }, "regularAssetTaskMonitoringPointTypeId": { "title": "regularAssetTaskMonitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_Id" }, "regularAssetTaskMonitoringPointTypeHasUpperCriticalBound": { "title": "regularAssetTaskMonitoringPointTypeHasUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasUpperCriticalBound" }, "regularAssetTaskMonitoringPointTypeHasUpperWarningBound": { "title": "regularAssetTaskMonitoringPointTypeHasUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasUpperWarningBound" }, "regularAssetTaskMonitoringPointTypeHasLowerCriticalBound": { "title": "regularAssetTaskMonitoringPointTypeHasLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasLowerCriticalBound" }, "regularAssetTaskMonitoringPointTypeHasLowerWarningBound": { "title": "regularAssetTaskMonitoringPointTypeHasLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_MonitoringPointType_HasLowerWarningBound" }, "triggerWhenLowerCriticalBound": { "title": "triggerWhenLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound" }, "triggerWhenLowerWarningBound": { "title": "triggerWhenLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound" }, "triggerWhenUpperCriticalBound": { "title": "triggerWhenUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound" }, "triggerWhenUpperWarningBound": { "title": "triggerWhenUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->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" } } }, "GetRegularAssetTaskFollowUpTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskFollowUpTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskFollowUpTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskFollowUpTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->InheritedFrom_Id" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Description" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->SynchronisedWithTypeObjectUpTo" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->LastConfirmedOn" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->Unsynchronised" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->LastConfirmedChangeLogId" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "addToWorkOrder": { "title": "addToWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->AddToWorkOrder" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTaskFollowUpTaskForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskFollowUpTaskForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskFollowUpTaskForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskFollowUpTaskForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->InheritedFrom_Id" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Id" }, "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->SequenceNumber" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTask->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" } } } }, "RegularAssetTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskFollowUpTaskFollowUpTaskLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskFollowUpTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskFollowUpTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskFollowUpTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskFollowUpTaskRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_Id" }, "monitoringPointTypeHasUpperCriticalBound": { "title": "monitoringPointTypeHasUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_HasUpperCriticalBound" }, "monitoringPointTypeHasUpperWarningBound": { "title": "monitoringPointTypeHasUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_HasUpperWarningBound" }, "monitoringPointTypeHasLowerCriticalBound": { "title": "monitoringPointTypeHasLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->MonitoringPointType_HasLowerCriticalBound" }, "monitoringPointTypeHasLowerWarningBound": { "title": "monitoringPointTypeHasLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTask->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" } } } }, "CreateRegularAssetTaskFollowUpTaskResourceActionRequest": { "title": "CreateRegularAssetTaskFollowUpTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskFollowUpTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "followUpTaskId", "addToWorkOrder" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Id" }, "followUpTaskId": { "title": "followUpTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->PermissionTree_Id", "x-systemGenerated": true }, "addToWorkOrder": { "title": "addToWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->AddToWorkOrder" }, "triggerWhenLowerCriticalBound": { "title": "triggerWhenLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound" }, "triggerWhenLowerWarningBound": { "title": "triggerWhenLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound" }, "triggerWhenUpperCriticalBound": { "title": "triggerWhenUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound" }, "triggerWhenUpperWarningBound": { "title": "triggerWhenUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskFollowUpTaskResourceActionRequest": { "title": "UpdateRegularAssetTaskFollowUpTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskFollowUpTask->FollowUpTask_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->SequenceNumber" }, { "title": "triggerWhenLowerCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenLowerCriticalBound" }, { "title": "triggerWhenLowerWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenLowerWarningBound" }, { "title": "triggerWhenUpperCriticalBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenUpperCriticalBound" }, { "title": "triggerWhenUpperWarningBound", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->TriggerWhenUpperWarningBound" }, { "title": "addToWorkOrder", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->AddToWorkOrder" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTask->Notes" } ] } } }, "DeleteRegularAssetTaskFollowUpTaskResourceActionRequest": { "title": "DeleteRegularAssetTaskFollowUpTaskResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskFollowUpTaskResourceAction": { "title": "BatchGetRegularAssetTaskFollowUpTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset 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 Task Follow Up Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskFollowUpTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTaskFollowUpTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskFollowUpTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTaskFollowUpTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskFollowUpTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskFollowUpTaskResourceActionRequest" } }, "BatchDeleteRegularAssetTaskFollowUpTaskResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskFollowUpTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskFollowUpTaskResourceActionRequest" } }, "ChangeRegularAssetTaskFollowUpTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskFollowUpTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskFollowUpTask->IsActive" } ] } } }, "ChangeRegularAssetTaskFollowUpTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskFollowUpTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskFollowUpTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskFollowUpTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskFollowUpTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskFollowUpTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskFollowUpTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskPermissionTreeResourceActionRequest" } }, "GetRegularAssetTaskFollowUpTaskExpressionResourceActionResponse": { "title": "GetRegularAssetTaskFollowUpTaskExpressionResourceActionResponse", "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": "GetRegularAssetTaskFollowUpTaskExpressionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->PermissionTree_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->InheritedFrom_Id" }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionExpression", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Expression" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->Notes" }, "regularAssetTaskFollowUpTaskId": { "title": "regularAssetTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id" }, "regularAssetTaskFollowUpTaskFollowUpTaskId": { "title": "regularAssetTaskFollowUpTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Id" }, "regularAssetTaskFollowUpTaskFollowUpTaskCode": { "title": "regularAssetTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Code" }, "regularAssetTaskFollowUpTaskFollowUpTaskDescription": { "title": "regularAssetTaskFollowUpTaskFollowUpTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Description" }, "regularAssetTaskFollowUpTaskRegularAssetTaskId": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Id" }, "regularAssetTaskFollowUpTaskRegularAssetTaskCode": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Code" }, "regularAssetTaskFollowUpTaskRegularAssetTaskDescription": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Description" }, "regularAssetTaskFollowUpTaskRegularAssetTaskInspectionType": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskInspectionType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_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" } } }, "GetRegularAssetTaskFollowUpTaskExpressionCollectionResourceActionResponse": { "title": "GetRegularAssetTaskFollowUpTaskExpressionCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskFollowUpTaskExpressionCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskFollowUpTaskExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskFollowUpTaskFollowUpTaskCode": { "title": "inheritedFromRegularAssetTypeTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->InheritedFrom_RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->SequenceNumber" }, "regularAssetTaskFollowUpTaskId": { "title": "regularAssetTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id" }, "regularAssetTaskFollowUpTaskFollowUpTaskCode": { "title": "regularAssetTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Code" }, "regularAssetTaskFollowUpTaskRegularAssetTaskCode": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Code" }, "regularAssetTaskFollowUpTaskRegularAssetTaskAssetId": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Asset_Id" }, "regularAssetTaskFollowUpTaskRegularAssetTaskInspectionType": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskInspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTask->IsInspection eq TRUE" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->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" } } } }, "GetRegularAssetTaskFollowUpTaskExpressionForRegularAssetTaskFollowUpTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskFollowUpTaskExpressionForRegularAssetTaskFollowUpTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskFollowUpTaskExpressionForRegularAssetTaskFollowUpTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskFollowUpTaskExpressionForRegularAssetTaskFollowUpTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->Notes" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->InheritedFrom_Id" }, "inheritedFromRegularAssetTypeTaskFollowUpTaskFollowUpTaskCode": { "title": "inheritedFromRegularAssetTypeTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->InheritedFrom_RegularAssetTypeTaskFollowUpTask_FollowUpTask_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->SequenceNumber" }, "regularAssetTaskFollowUpTaskId": { "title": "regularAssetTaskFollowUpTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id" }, "regularAssetTaskFollowUpTaskFollowUpTaskCode": { "title": "regularAssetTaskFollowUpTaskFollowUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_FollowUpTask_Code" }, "regularAssetTaskFollowUpTaskRegularAssetTaskCode": { "title": "regularAssetTaskFollowUpTaskRegularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_RegularAssetTask_Code" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->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" } } } }, "RegularAssetTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskExpressionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskExpressionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskFollowUpTaskExpressionMonitoringPointTriggerExpressionLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskExpressionMonitoringPointTriggerExpressionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskExpressionMonitoringPointTriggerExpressionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskExpressionMonitoringPointTriggerExpressionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Expression" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskFollowUpTaskExpressionRegularAssetTaskFollowUpTaskLookupResourceActionResponse": { "title": "RegularAssetTaskFollowUpTaskExpressionRegularAssetTaskFollowUpTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskFollowUpTaskExpressionRegularAssetTaskFollowUpTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskFollowUpTaskExpressionRegularAssetTaskFollowUpTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "followUpTaskCode": { "title": "followUpTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Code" }, "followUpTaskDescription": { "title": "followUpTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->FollowUpTask_Description" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_Description" }, "regularAssetTaskInspectionType": { "title": "regularAssetTaskInspectionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTask->RegularAssetTask_InspectionType", "x-formatSpecifier": "InspectionType", "x-NullExpression": "RegularAssetTask->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" } } } }, "CreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest": { "title": "CreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskFollowUpTaskId", "monitoringPointTriggerExpressionId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->PermissionTree_Id", "x-systemGenerated": true }, "regularAssetTaskFollowUpTaskId": { "title": "regularAssetTaskFollowUpTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->RegularAssetTaskFollowUpTask_Id" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->MonitoringPointTriggerExpression_Id" }, "manualReadingRequired": { "title": "manualReadingRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest": { "title": "UpdateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskFollowUpTaskExpression->SequenceNumber" }, { "title": "manualReadingRequired", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->ManualReadingRequired" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskFollowUpTaskExpression->Notes" } ] } } }, "DeleteRegularAssetTaskFollowUpTaskExpressionResourceActionRequest": { "title": "DeleteRegularAssetTaskFollowUpTaskExpressionResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskFollowUpTaskExpressionResourceAction": { "title": "BatchGetRegularAssetTaskFollowUpTaskExpressionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset 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 Task Follow Up Task Expression entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskFollowUpTaskExpressionResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest": { "title": "BatchCreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, "BatchUpdateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, "BatchDeleteRegularAssetTaskFollowUpTaskExpressionResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskFollowUpTaskExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskFollowUpTaskExpressionResourceActionRequest" } }, "ChangeRegularAssetTaskFollowUpTaskExpressionIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskFollowUpTaskExpressionIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskFollowUpTaskExpression->IsActive" } ] } } }, "ChangeRegularAssetTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskFollowUpTaskExpression->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskFollowUpTaskExpressionIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskFollowUpTaskExpressionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskExpressionIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskFollowUpTaskExpressionPermissionTreeResourceActionRequest" } }, "GetRegularAssetTaskResourceResourceActionResponse": { "title": "GetRegularAssetTaskResourceResourceActionResponse", "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": "GetRegularAssetTaskResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskResource->LastConfirmedOn" }, "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskResource->RulesLastEvaluatedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskResource->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->PermissionTree_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->InheritedFrom_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_Code" }, "resourceContactDetailId": { "title": "resourceContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_ContactDetailId" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Trade_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->UnitOfMeasurement_Description" }, "unitOfMeasurementMeasurementType": { "title": "unitOfMeasurementMeasurementType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->UnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskResource->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" } } }, "GetRegularAssetTaskResourceCollectionResourceActionResponse": { "title": "GetRegularAssetTaskResourceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskResourceCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->IsActive" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Description" }, "regularAssetTaskAssetTreePathItems": { "title": "regularAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskComponentTreePathItems": { "title": "regularAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->SequenceNumber" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Competency_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->InheritedFrom_Id" }, "inheritedFromResourceContactDetailFirstName": { "title": "inheritedFromResourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->InheritedFrom_Resource_ContactDetailFirstName" }, "inheritedFromResourceContactDetailLastName": { "title": "inheritedFromResourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->InheritedFrom_Resource_ContactDetailLastName" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Notes" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskResource->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RuleEvaluationPassed" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRegularAssetTaskResourceForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskResourceForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskResourceForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskResourceForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->IsActive" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->SequenceNumber" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Quantity" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Proficiency" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_ContactDetailLastName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Competency_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->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" } } } }, "RegularAssetTaskResourceFilterByTradeLookupResourceActionResponse": { "title": "RegularAssetTaskResourceFilterByTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceFilterByTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceFilterByTradeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceFilterByTradeUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskResourceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceCompetencyLookupResourceActionResponse": { "title": "RegularAssetTaskResourceCompetencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceCompetencyLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceCompetencyLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskResourceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskResourceRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskResourceResourceLookupResourceActionResponse": { "title": "RegularAssetTaskResourceResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceResourceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceSectionLookupResourceActionResponse": { "title": "RegularAssetTaskResourceSectionLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceSectionLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceSectionLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceSystemAssignResourceLookupResourceActionResponse": { "title": "RegularAssetTaskResourceSystemAssignResourceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceSystemAssignResourceLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceSystemAssignResourceLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceTradeFilterLookupResourceActionResponse": { "title": "RegularAssetTaskResourceTradeFilterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceTradeFilterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceTradeFilterLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskResourceTradeLookupResourceActionResponse": { "title": "RegularAssetTaskResourceTradeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceTradeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceTradeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskResourceUnitOfMeasurementLookupResourceActionResponse": { "title": "RegularAssetTaskResourceUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskResourceUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskResourceUnitOfMeasurementLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRegularAssetTaskResourceResourceActionRequest": { "title": "CreateRegularAssetTaskResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "quantity", "tradeId" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Id" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Id" }, "usage": { "title": "usage", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "RegularAssetTaskResource->Usage", "x-systemGenerated": true, "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->PermissionTree_Id", "x-systemGenerated": true }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Proficiency" }, "quantity": { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskResource->Quantity" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_Id" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ResourceType", "x-systemGenerated": true, "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->UnitOfMeasurement_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskResourceResourceActionRequest": { "title": "UpdateRegularAssetTaskResourceResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->RegularAssetTask_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Notes" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_Id" }, { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Id" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Proficiency" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "quantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskResource->Quantity" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->UnitOfMeasurement_Id" } ] } } }, "DeleteRegularAssetTaskResourceResourceActionRequest": { "title": "DeleteRegularAssetTaskResourceResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskResourceResourceAction": { "title": "BatchGetRegularAssetTaskResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Resource entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskResourceResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskResourceResourceActionRequest": { "title": "BatchCreateRegularAssetTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskResourceResourceActionRequest" } }, "BatchUpdateRegularAssetTaskResourceResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskResourceResourceActionRequest" } }, "BatchDeleteRegularAssetTaskResourceResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskResourceResourceActionRequest" } }, "ChangeRegularAssetTaskResourceIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskResourceIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskResource->IsActive" } ] } } }, "ChangeRegularAssetTaskResourcePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskResourcePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskResource->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskResourceIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskResourceIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskResourcePermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTaskResourceResourceActionRequest": { "title": "MatchUpdateRegularAssetTaskResourceResourceActionRequest", "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": "RegularAssetTaskResource->Quantity" }, { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Resource_Id" }, { "title": "resourceType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->ResourceType", "x-formatSpecifier": "ResourceType" }, { "title": "sectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Section_Id" }, { "title": "tradeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Trade_Id" }, { "title": "competencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Competency_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->UnitOfMeasurement_Id" }, { "title": "usage", "format": "composite", "x-nullable": false, "x-propertyPath": "RegularAssetTaskResource->Usage", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->SequenceNumber" }, { "title": "proficiency", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskResource->Proficiency" } ] } } }, "GetRegularAssetTaskSpareResourceActionResponse": { "title": "GetRegularAssetTaskSpareResourceActionResponse", "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": "GetRegularAssetTaskSpareResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSpare->LastConfirmedOn" }, "ruleEvaluationFailedReason": { "title": "ruleEvaluationFailedReason", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->RuleEvaluationFailedReason", "x-formatSpecifier": "RuleEvaluationFailedReason" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->RuleEvaluationPassed" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSpare->RulesLastEvaluatedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSpare->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSpare->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSpare->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->PermissionTree_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSpare->InheritedFrom_LastConfirmedOn" }, "inheritedFromPreferredMaterialMasterId": { "title": "inheritedFromPreferredMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Id" }, "inheritedFromPreferredMaterialMasterCode": { "title": "inheritedFromPreferredMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Code" }, "inheritedFromPreferredMaterialMasterDescription": { "title": "inheritedFromPreferredMaterialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->InheritedFrom_PreferredMaterialMaster_Description" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Id" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Description" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Code" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->Quantity" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Description" }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Id" }, "stockItemAlternativeDescription": { "title": "stockItemAlternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->StockItem_AlternativeDescription" }, "stockItemMaterialMasterId": { "title": "stockItemMaterialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->StockItem_MaterialMaster_Id" }, "stockItemMaterialMasterCode": { "title": "stockItemMaterialMasterCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->StockItem_MaterialMaster_Code" }, "stockItemWarehouseId": { "title": "stockItemWarehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Warehouse_Id" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Warehouse_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" } } }, "GetRegularAssetTaskSpareCollectionResourceActionResponse": { "title": "GetRegularAssetTaskSpareCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskSpareCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskSpareCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->IsInherited" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->InheritedFrom_Id" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Description" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Description" }, "regularAssetTaskAssetTreePathItems": { "title": "regularAssetTaskAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Asset_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "regularAssetTaskComponentTreePathItems": { "title": "regularAssetTaskComponentTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Component_TreePathItems", "x-formatSpecifier": "TreePathItem" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Warehouse_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->Quantity" }, "rulesLastEvaluatedOn": { "title": "rulesLastEvaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSpare->RulesLastEvaluatedOn" }, "ruleEvaluationPassed": { "title": "ruleEvaluationPassed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->RuleEvaluationPassed" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetSpareForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetSpareForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetSpareForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetSpareForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Code" }, "materialMasterDescription": { "title": "materialMasterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Description" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Commodity_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Description" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->Quantity" }, "stockItemWarehouseCode": { "title": "stockItemWarehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Warehouse_Code" }, "stockItemWarehouseDescription": { "title": "stockItemWarehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskSpareChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskSpareChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSpareCommodityLookupResourceActionResponse": { "title": "RegularAssetTaskSpareCommodityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareCommodityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareCommodityLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSpareCostElementLookupResourceActionResponse": { "title": "RegularAssetTaskSpareCostElementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareCostElementLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSpareInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskSpareInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponse": { "title": "RegularAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareMaterialMasterForCommodityLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSpareMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetTaskSpareMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareMaterialMasterLookupResourceActionResponseItemProperties", "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" }, "commodityDescription": { "title": "commodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Commodity_Description" }, "commodityCode": { "title": "commodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "MaterialMaster->Commodity_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" } } } }, "RegularAssetTaskSpareTaskRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskSpareTaskRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareTaskRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareTaskRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponse": { "title": "RegularAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareStockItemForMaterialMasterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskSpareStockItemLookupResourceActionResponse": { "title": "RegularAssetTaskSpareStockItemLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSpareStockItemLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSpareStockItemLookupResourceActionResponseItemProperties", "type": "object", "properties": { "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Id" }, "materialMasterCode": { "title": "materialMasterCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Code" }, "materialMasterCommodityId": { "title": "materialMasterCommodityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Id" }, "materialMasterCommodityCode": { "title": "materialMasterCommodityCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Code" }, "materialMasterCommodityDescription": { "title": "materialMasterCommodityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->MaterialMaster_Commodity_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "StockItem->AlternativeDescription" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "StockItem->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "StockItem->Warehouse_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTaskSpareResourceActionRequest": { "title": "CreateRegularAssetTaskSpareResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskSpareResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "stockItemId", "costElementId", "quantity" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskSpare->RegularAssetTask_Id" }, "materialMasterId": { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Id", "x-systemGenerated": true }, "stockItemId": { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->PermissionTree_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->Notes" }, "quantity": { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskSpare->Quantity" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskSpareResourceActionRequest": { "title": "UpdateRegularAssetTaskSpareResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "materialMasterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->MaterialMaster_Id" }, { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->Notes" }, { "title": "quantity", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskSpare->Quantity" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSpare->SequenceNumber" } ] } } }, "DeleteRegularAssetTaskSpareResourceActionRequest": { "title": "DeleteRegularAssetTaskSpareResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskSpareResourceAction": { "title": "BatchGetRegularAssetTaskSpareResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Spare entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Spare entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskSpareResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskSpareResourceActionRequest": { "title": "BatchCreateRegularAssetTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskSpareResourceActionRequest" } }, "BatchUpdateRegularAssetTaskSpareResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskSpareResourceActionRequest" } }, "BatchDeleteRegularAssetTaskSpareResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskSpareResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskSpareResourceActionRequest" } }, "ChangeRegularAssetTaskSpareIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskSpareIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskSpare->IsActive" } ] } } }, "ChangeRegularAssetTaskSparePermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskSparePermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskSpare->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskSpareIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskSpareIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskSpareIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskSparePermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskSparePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskSparePermissionTreeResourceActionRequest" } }, "MatchUpdateRegularAssetTaskSpareResourceActionRequest": { "title": "MatchUpdateRegularAssetTaskSpareResourceActionRequest", "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": "RegularAssetTaskSpare->Quantity" }, { "title": "stockItemId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->StockItem_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSpare->CostElement_Id" } ] } } }, "GetRegularAssetTaskSubTaskResourceActionResponse": { "title": "GetRegularAssetTaskSubTaskResourceActionResponse", "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": "GetRegularAssetTaskSubTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSubTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSubTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Unsynchronised" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSubTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSubTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->PermissionTree_Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->AlternativeDescription" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSubTask->InheritedFrom_LastConfirmedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Notes" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->RegularAssetTask_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRegularAssetTaskSubTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskSubTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskSubTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskSubTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->RegularAssetTask_Description" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->Description" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->AlternativeDescription" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->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" } } } }, "GetRegularAssetTaskSubTaskForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskSubTaskForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskSubTaskForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskSubTaskForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->AlternativeDescription" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->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" } } } }, "RegularAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSubTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSubTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSubTaskRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskSubTaskRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSubTaskRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSubTaskRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTaskSubTaskResourceActionRequest": { "title": "CreateRegularAssetTaskSubTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskSubTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "description", "alternativeDescription" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->RegularAssetTask_Id" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Code" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->Description" }, "alternativeDescription": { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->AlternativeDescription" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskSubTaskResourceActionRequest": { "title": "UpdateRegularAssetTaskSubTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskSubTask->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Notes" }, { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSubTask->Code" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->Description" }, { "title": "alternativeDescription", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "RegularAssetTaskSubTask->AlternativeDescription" } ] } } }, "DeleteRegularAssetTaskSubTaskResourceActionRequest": { "title": "DeleteRegularAssetTaskSubTaskResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskSubTaskResourceAction": { "title": "BatchGetRegularAssetTaskSubTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Sub Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Sub Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskSubTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskSubTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskSubTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTaskSubTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskSubTaskResourceActionRequest" } }, "BatchDeleteRegularAssetTaskSubTaskResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskSubTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskSubTaskResourceActionRequest" } }, "ChangeRegularAssetTaskSubTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskSubTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskSubTask->IsActive" } ] } } }, "ChangeRegularAssetTaskSubTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskSubTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskSubTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskSubTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskSubTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskSubTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskSubTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskSubTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskSubTaskPermissionTreeResourceActionRequest" } }, "GetRegularAssetTaskSuppressedTaskResourceActionResponse": { "title": "GetRegularAssetTaskSuppressedTaskResourceActionResponse", "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": "GetRegularAssetTaskSuppressedTaskResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsActive" }, "isHistorical": { "title": "isHistorical", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsHistorical" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsInherited" }, "isProposed": { "title": "isProposed", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsProposed" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->LastConfirmedChangeLogId" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSuppressedTask->LastConfirmedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SequenceNumber" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSuppressedTask->SynchronisedWithTypeObjectUpTo" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->Unsynchronised" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSuppressedTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSuppressedTask->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Description" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->InheritedFrom_Id" }, "inheritedFromLastConfirmedOn": { "title": "inheritedFromLastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSuppressedTask->InheritedFrom_LastConfirmedOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->Notes" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Description" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Description" }, "suppressedTaskIsActive": { "title": "suppressedTaskIsActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_IsActive" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTaskSuppressedTask->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" } } }, "GetRegularAssetTaskSuppressedTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskSuppressedTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskSuppressedTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskSuppressedTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Id" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->InheritedFrom_Id" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsActive" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Description" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Description" }, "lastConfirmedOn": { "title": "lastConfirmedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSuppressedTask->LastConfirmedOn" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsInherited" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SequenceNumber" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTaskSuppressedTask->SuppressedDaysAfter gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, "unsynchronised": { "title": "unsynchronised", "type": "boolean", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->Unsynchronised" }, "lastConfirmedChangeLogId": { "title": "lastConfirmedChangeLogId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->LastConfirmedChangeLogId" }, "synchronisedWithTypeObjectUpTo": { "title": "synchronisedWithTypeObjectUpTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RegularAssetTaskSuppressedTask->SynchronisedWithTypeObjectUpTo" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->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" } } } }, "GetRegularAssetTaskSuppressedTaskForRegularAssetTaskCollectionResourceActionResponse": { "title": "GetRegularAssetTaskSuppressedTaskForRegularAssetTaskCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRegularAssetTaskSuppressedTaskForRegularAssetTaskCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRegularAssetTaskSuppressedTaskForRegularAssetTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->IsInherited" }, "developmentStatus": { "title": "developmentStatus", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->DevelopmentStatus", "x-formatSpecifier": "AssetDevelopmentStatus" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Id" }, "suppressedTaskCode": { "title": "suppressedTaskCode", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Code" }, "suppressedTaskDescription": { "title": "suppressedTaskDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Description" }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTaskSuppressedTask->SuppressedDaysAfter gt 0" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTaskSuppressedTask->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" } } } }, "RegularAssetTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSuppressedTaskChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponse": { "title": "RegularAssetTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSuppressedTaskInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RegularAssetTaskSuppressedTaskRegularAssetTaskLookupResourceActionResponse": { "title": "RegularAssetTaskSuppressedTaskRegularAssetTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSuppressedTaskRegularAssetTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSuppressedTaskRegularAssetTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RegularAssetTaskSuppressedTaskSuppressedTaskLookupResourceActionResponse": { "title": "RegularAssetTaskSuppressedTaskSuppressedTaskLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RegularAssetTaskSuppressedTaskSuppressedTaskLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "RegularAssetTaskSuppressedTaskSuppressedTaskLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RegularAssetTask->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRegularAssetTaskSuppressedTaskResourceActionRequest": { "title": "CreateRegularAssetTaskSuppressedTaskResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRegularAssetTaskSuppressedTaskResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "regularAssetTaskId", "additionalNumberOfCyclesSuppressed", "suppressionPercentage", "suppressedDaysAfter", "suppressedDaysBefore", "suppressedTaskId" ], "properties": { "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->RegularAssetTask_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->PermissionTree_Id", "x-systemGenerated": true }, "additionalNumberOfCyclesSuppressed": { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, "suppressionPercentage": { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressionPercentage" }, "suppressedDaysAfter": { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysAfter" }, "suppressedDaysBefore": { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SequenceNumber" }, "suppressedTaskId": { "title": "suppressedTaskId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRegularAssetTaskSuppressedTaskResourceActionRequest": { "title": "UpdateRegularAssetTaskSuppressedTaskResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": false, "exclusiveMinimum": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedTask_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->SequenceNumber" }, { "title": "additionalNumberOfCyclesSuppressed", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->AdditionalNumberOfCyclesSuppressed" }, { "title": "suppressionPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressionPercentage", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore gt 0 OR RegularAssetTaskSuppressedTask->SuppressedDaysAfter gt 0" }, { "title": "suppressedDaysAfter", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysAfter", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, { "title": "suppressedDaysBefore", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "RegularAssetTaskSuppressedTask->SuppressedDaysBefore", "x-NullExpression": "RegularAssetTaskSuppressedTask->SuppressionPercentage gt 0" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RegularAssetTaskSuppressedTask->Notes" } ] } } }, "DeleteRegularAssetTaskSuppressedTaskResourceActionRequest": { "title": "DeleteRegularAssetTaskSuppressedTaskResourceActionRequest", "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 } } }, "BatchGetRegularAssetTaskSuppressedTaskResourceAction": { "title": "BatchGetRegularAssetTaskSuppressedTaskResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Regular Asset Task Suppressed Task entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Regular Asset Task Suppressed Task entities", "items": { "$ref": "#/definitions/GetRegularAssetTaskSuppressedTaskResourceActionResponse" } }, "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" } } }, "BatchCreateRegularAssetTaskSuppressedTaskResourceActionRequest": { "title": "BatchCreateRegularAssetTaskSuppressedTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRegularAssetTaskSuppressedTaskResourceActionRequest" } }, "BatchUpdateRegularAssetTaskSuppressedTaskResourceActionRequest": { "title": "BatchUpdateRegularAssetTaskSuppressedTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRegularAssetTaskSuppressedTaskResourceActionRequest" } }, "BatchDeleteRegularAssetTaskSuppressedTaskResourceActionRequest": { "title": "BatchDeleteRegularAssetTaskSuppressedTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRegularAssetTaskSuppressedTaskResourceActionRequest" } }, "ChangeRegularAssetTaskSuppressedTaskIsActiveResourceActionRequest": { "title": "ChangeRegularAssetTaskSuppressedTaskIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskSuppressedTask->IsActive" } ] } } }, "ChangeRegularAssetTaskSuppressedTaskPermissionTreeResourceActionRequest": { "title": "ChangeRegularAssetTaskSuppressedTaskPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "RegularAssetTaskSuppressedTask->PermissionTree_Id" } ] } } }, "BatchChangeRegularAssetTaskSuppressedTaskIsActiveResourceActionRequest": { "title": "BatchChangeRegularAssetTaskSuppressedTaskIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskSuppressedTaskIsActiveResourceActionRequest" } }, "BatchChangeRegularAssetTaskSuppressedTaskPermissionTreeResourceActionRequest": { "title": "BatchChangeRegularAssetTaskSuppressedTaskPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRegularAssetTaskSuppressedTaskPermissionTreeResourceActionRequest" } } }, "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 FMECA" }, { "name": "Asset FMECA Task" }, { "name": "Asset Function" }, { "name": "Asset Task Spares" }, { "name": "Asset Tree" }, { "name": "Auxiliary Asset Task" }, { "name": "Auxiliary Asset Task Resource" }, { "name": "Auxiliary Asset Task Spare" }, { "name": "Auxiliary Asset Task Sub Task" }, { "name": "In-Place Asset" }, { "name": "In-Place Asset Attribute" }, { "name": "In-Place Asset Consumption" }, { "name": "In-Place Asset Meter" }, { "name": "In-Place Asset Responsibility" }, { "name": "In-Place Asset Spare" }, { "name": "Placeholder Asset" }, { "name": "Placeholder Asset Active Condition" }, { "name": "Placeholder Asset Attribute" }, { "name": "Placeholder Asset Component" }, { "name": "Placeholder Asset Component Active Condition" }, { "name": "Placeholder Asset Component Attribute" }, { "name": "Placeholder Asset Component Condition" }, { "name": "Placeholder Asset Component Document" }, { "name": "Placeholder Asset Component Option Value" }, { "name": "Placeholder Asset Condition" }, { "name": "Placeholder Asset Consumption" }, { "name": "Placeholder Asset Document" }, { "name": "Placeholder Asset Meter" }, { "name": "Placeholder Asset Responsibility" }, { "name": "Placeholder Asset Spare" }, { "name": "Regular Asset" }, { "name": "Regular Asset Active Condition" }, { "name": "Regular Asset Attribute" }, { "name": "Regular Asset Component" }, { "name": "Regular Asset Component Attribute" }, { "name": "Regular Asset Component Document" }, { "name": "Regular Asset Condition" }, { "name": "Regular Asset Consumption" }, { "name": "Regular Asset Document" }, { "name": "Regular Asset File Attachment" }, { "name": "Regular Asset Meter" }, { "name": "Regular Asset Monitoring Point Trigger" }, { "name": "Regular Asset Monitoring Point Trigger Parameter" }, { "name": "Regular Asset Option Value" }, { "name": "Regular Asset Responsibility" }, { "name": "Regular Asset Spare" }, { "name": "Regular Asset Task" }, { "name": "Regular Asset Task Attribute" }, { "name": "Regular Asset Task Auxiliary Task" }, { "name": "Regular Asset Task Condition" }, { "name": "Regular Asset Task Document" }, { "name": "Regular Asset Task File Attachment" }, { "name": "Regular Asset Task Follow Up Task" }, { "name": "Regular Asset Task Follow Up Task Expression" }, { "name": "Regular Asset Task Resource" }, { "name": "Regular Asset Task Spare" }, { "name": "Regular Asset Task Sub Task" }, { "name": "Regular Asset Task Suppressed Task" } ], "x-tagGroups": [ { "name": "AMPC.Assets", "tags": [ "Asset FMECA", "Asset FMECA Task", "Asset Function", "Asset Task Spares", "Asset Tree", "Auxiliary Asset Task", "Auxiliary Asset Task Resource", "Auxiliary Asset Task Spare", "Auxiliary Asset Task Sub Task", "In-Place Asset", "In-Place Asset Attribute", "In-Place Asset Consumption", "In-Place Asset Meter", "In-Place Asset Responsibility", "In-Place Asset Spare", "Placeholder Asset", "Placeholder Asset Active Condition", "Placeholder Asset Attribute", "Placeholder Asset Component", "Placeholder Asset Component Active Condition", "Placeholder Asset Component Attribute", "Placeholder Asset Component Condition", "Placeholder Asset Component Document", "Placeholder Asset Component Option Value", "Placeholder Asset Condition", "Placeholder Asset Consumption", "Placeholder Asset Document", "Placeholder Asset Meter", "Placeholder Asset Responsibility", "Placeholder Asset Spare", "Regular Asset", "Regular Asset Active Condition", "Regular Asset Attribute", "Regular Asset Component", "Regular Asset Component Attribute", "Regular Asset Component Document", "Regular Asset Condition", "Regular Asset Consumption", "Regular Asset Document", "Regular Asset File Attachment", "Regular Asset Meter", "Regular Asset Monitoring Point Trigger", "Regular Asset Monitoring Point Trigger Parameter", "Regular Asset Option Value", "Regular Asset Responsibility", "Regular Asset Spare", "Regular Asset Task", "Regular Asset Task Attribute", "Regular Asset Task Auxiliary Task", "Regular Asset Task Condition", "Regular Asset Task Document", "Regular Asset Task File Attachment", "Regular Asset Task Follow Up Task", "Regular Asset Task Follow Up Task Expression", "Regular Asset Task Resource", "Regular Asset Task Spare", "Regular Asset Task Sub Task", "Regular Asset Task Suppressed Task" ] } ] }