{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key BI 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.entitydeletecollection+json", "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.userdefinedquerypage+json", "application/vnd.onkey.entitycollectionpage+json" ], "paths": { "/Modules/BI/Insights/PortalUrl": { "get": { "tags": [ "Insights" ], "summary": "Get the Insights Portal Url for the current authenticated user", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| url | InsightsPortalInfo->Url | string | |\r\n", "operationId": "GetInsightsPortalUrl", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Insights", "schema": { "$ref": "#/definitions/GetReportUrlResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Insights/Users/Available": { "get": { "tags": [ "Insights" ], "summary": "Get a list of available Insights User 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 | InsightsUser->Id | string | |\r\n| name | InsightsUser->Name | string | |\r\n| userDirectory | InsightsUser->UserDirectory | string | |\r\n| userId | InsightsUser->UserId | string | |\r\n", "operationId": "GetInsightsUsersAvailable", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Insights collection", "schema": { "$ref": "#/definitions/GetInsightsUsersAvailableResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/IntegrationToken": { "get": { "tags": [ "Report" ], "summary": "Get Report Server Integration Token", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| accessToken | ReportServerIntegrationToken->AccessToken | string | |\r\n| expiresIn | ReportServerIntegrationToken->ExpiresIn | string | |\r\n| integrationUrl | ReportServerIntegrationToken->IntegrationUrl | string | |\r\n| tokenType | ReportServerIntegrationToken->TokenType | string | |\r\n", "operationId": "GetReportServerIntegrationToken", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "EntityType", "in": "query", "description": "Filter reports by Entity Type", "x-schema": { "$ref": "#/definitions/EntityType" }, "x-nullable": true, "enum": [ "Alarm", "NewAlarm", "AlarmExpression", "AlarmExpressionTask", "AlarmAttribute", "AlarmDocument", "AlarmType", "MonitoringPoint", "MonitoringPointBoundEvaluationLog", "MonitoringPointParameter", "MonitoringPointReading", "MonitoringPointTrigger", "MonitoringPointTriggerExpression", "MonitoringPointTriggerExpressionAlarmType", "MonitoringPointTriggerExpressionParameter", "MonitoringPointTriggerExpressionEvaluation", "MonitoringPointTriggerExpressionEvaluationLog", "MonitoringPointType", "MonitoringPointTypeParameter", "MonitoringPointAttribute", "MonitoringPointDocument", "AuxiliaryAssetTask", "AuxiliaryAssetTaskResource", "AuxiliaryAssetTaskSpare", "AuxiliaryAssetTaskSubTask", "RegularAssetComponent", "RegularAssetComponentAttribute", "RegularAssetComponentDocument", "RegularAssetComponentRuleEvaluationFailure", "AssetComponent", "AssetWarranty", "PlaceholderAssetComponent", "PlaceholderAssetComponentOptionValue", "PlaceholderAssetComponentCondition", "PlaceholderAssetMeter", "PlaceholderAssetComponentRuleEvaluationFailure", "RegularAssetCondition", "RegularAssetActiveCondition", "AssetFmeca", "RegularAssetOptionValue", "Asset", "RegularAssetAttribute", "RegularAssetDocument", "RegularAssetFileAttachment", "PlaceholderAsset", "PlaceholderAssetAttribute", "PlaceholderAssetDocument", "PlaceholderAssetFileAttachment", "PlaceholderAssetRuleEvaluationFailure", "PlaceholderAssetResponsibility", "PlaceholderAssetCondition", "PlaceholderAssetActiveCondition", "AssetTask", "SetAssetTaskSpareWarehouseEntity", "RegularAssetTask", "RegularAssetTaskRuleEvaluationFailure", "RegularAssetTaskAttribute", "RegularAssetTaskAuxiliaryTask", "RegularAssetTaskFollowUpTask", "RegularAssetTaskFollowUpTaskExpression", "RegularAssetTaskSuppressedTask", "RegularAssetTaskResource", "RegularAssetTaskResourceRuleEvaluationFailure", "RegularAssetTaskSpare", "RegularAssetTaskSpareRuleEvaluationFailure", "RegularAssetTaskSubTask", "RegularAssetTaskFileAttachment", "AuxiliaryAssetTypeTask", "AuxiliaryAssetTypeTaskResource", "AuxiliaryAssetTypeTaskSpare", "AuxiliaryAssetTypeTaskSubTask", "RegularAssetTypeComponent", "RegularAssetTypeComponentAttribute", "RegularAssetTypeComponentDocument", "AssetTypeComponent", "PlaceholderAssetTypeComponent", "PlaceholderAssetTypeComponentCondition", "PlaceholderAssetTypeComponentAttribute", "PlaceholderAssetTypeComponentDocument", "PlaceholderAssetTypeComponentRuleLink", "RegularAssetTypeComponentRuleLink", "PlaceholderAssetComponentAttribute", "PlaceholderAssetComponentDocument", "PlaceholderAssetComponentActiveCondition", "AssetTypeFmeca", "AssetTypeFunction", "AssetFunction", "AssetFmecaTask", "AssetTypeFmecaTask", "AssetTypeFolder", "RegularAssetTypeOption", "AssetType", "PlaceholderAssetType", "PlaceholderAssetTypeSpare", "PlaceholderAssetTypeAttribute", "PlaceholderAssetTypeDocument", "PlaceholderAssetTypeResponsibility", "PlaceholderAssetTypeRuleLink", "RegularAssetTypeTask", "RegularAssetTypeTaskAttribute", "RegularAssetTypeTaskAuxiliaryTask", "RegularAssetTypeTaskCondition", "RegularAssetTypeTaskDocument", "RegularAssetTypeTaskFollowUpTask", "RegularAssetTypeTaskFollowUpTaskExpression", "AssetTypeTask", "AssetTypeTaskResource", "AssetTaskResource", "AssetTaskSpare", "AssetTypeTaskSpare", "RegularAssetTypeTaskResource", "RegularAssetTypeTaskRuleLink", "RegularAssetTypeTaskSpare", "RegularAssetTypeTaskSubTask", "RegularAssetTypeTaskSuppressedTask", "Condition", "ConditionType", "Event", "FailureCause", "FailureCauseType", "FailureMechanism", "FailureMechanismType", "FailureMode", "FailureModeType", "InPlaceAssetMeter", "InPlaceAssetAttribute", "InPlaceAssetFileAttachment", "InPlaceAssetRuleEvaluationFailure", "InPlaceAssetResponsibility", "InPlaceAssetSpare", "InPlaceAssetType", "InPlaceAssetTypeResponsibility", "InPlaceAssetTypeRuleLink", "InPlaceAssetTypeSpare", "InPlaceAsset", "Option", "OptionCategory", "RegularAsset", "RegularAssetTaskDocument", "RegularAssetMeter", "RegularAssetResponsibility", "RegularAssetMonitoringPointTrigger", "RegularAssetSpare", "RegularAssetTaskCondition", "RegularAssetType", "RegularAssetTypeAttribute", "RegularAssetTypeDocument", "RegularAssetTypeCondition", "PlaceholderAssetTypeCondition", "RegularAssetTypeRule", "RegularAssetTypeResponsibility", "RegularAssetTypeMonitoringPointTrigger", "RegularAssetTypeSpare", "RepairType", "Rule", "RuleCategory", "RuleOption", "StandardTask", "StandardTaskSpare", "StandardTaskSubTask", "StandardTaskResource", "StandardTaskAttribute", "StandardTaskDocument", "TaskImportance", "TaskInterval", "TaskIntervalType", "TaskRollUpPoint", "TypeOfWork", "RegularAssetTypeTaskSpareRuleLink", "InPlaceAssetTypeAttribute", "RegularAssetTypeTaskResourceRuleLink", "PlaceholderAssetSpare", "RegularAssetMonitoringPointTriggerParameter", "AssetSpare", "AssetTypeSpare", "AssetMeter", "AssetConsumption", "RegularAssetConsumption", "PlaceholderAssetConsumption", "InPlaceAssetConsumption", "WarrantyType", "RegularAssetTypeFileAttachment", "Meter", "MeterAttribute", "MeterDocument", "MeterReading", "PredictedMeterReading", "TimeLossCategory", "TimeLossReason", "TimeLossType", "Consumable", "AcquisitionStatus", "AcquisitionType", "DocumentFolder", "DocumentRecord", "DocumentRecordAttribute", "FileAttachment", "FileAttachmentCategory", "FileAttachmentContentHistory", "DocumentRecordFileHistory", "Costing", "CostingBudget", "CostCentre", "CostCentreAttribute", "CostCentreDocument", "CostCentreType", "CostElement", "CostElementAttribute", "CostElementDocument", "Currency", "BudgetTemplate", "BudgetTemplateParameter", "FinancialYear", "FinancialYearPeriod", "GeneralLedger", "GeneralLedgerAttribute", "GeneralLedgerDocument", "CurrencyRate", "Budget", "BudgetParameter", "AddressType", "Approval", "Attribute", "AttributeAllowedValue", "Calendar", "CalendarDay", "CalendarException", "CalendarDayHour", "Classification", "ClassificationAllowedValue", "EmailType", "Language", "OperationalRole", "OperationalRoleTemplate", "OperationalRoleResource", "PhoneNumberType", "UserOperationalRole", "UserOperationalRoleTemplate", "UserOperationalRoleResource", "TermsAndCondition", "TermsAndConditionVersion", "TermsAndConditionOperationalRole", "UserTermsAndConditionVersion", "Location", "LocationAttribute", "LocationDocument", "LocalisationSet", "LocalisationKey", "LocalisationTranslation", "Phrase", "PhraseTranslation", "PreconfiguredReason", "Site", "SiteAttribute", "SiteDocument", "SiteType", "Supplier", "SupplierFileAttachment", "SupplierAttribute", "SupplierDocument", "SupplierContactAddress", "SupplierContactEmail", "SupplierContactPhoneNumber", "SupplierResource", "SupplierTaxRate", "UnitOfMeasurement", "SiteResource", "SiteContactAddress", "SiteContactEmail", "SiteContactPhoneNumber", "ChangeDataTrigger", "ChangeDataTriggerOccurrenceLog", "ChangeDataTriggerCriteria", "NotificationTemplate", "ChangeDataTriggerCriteriaParameter", "ChangeDataTriggerNotificationEvent", "NotificationTemplateParameter", "ChangeDataTriggerNotificationEventAttachment", "ChangeDataTriggerNotificationEventAttachmentParameter", "RequestType", "Category", "Commodity", "MaterialMaster", "MaterialMasterAttribute", "MaterialMasterDocument", "MaterialMasterBin", "MaterialMasterSupplier", "MaterialMasterLinkWarehouse", "StockItem", "StockItemFileAttachment", "StockItemAttribute", "StockItemDocument", "StockItemBin", "StockItemSupplier", "WarehouseAttribute", "Warehouse", "WarehouseDocument", "Requisition", "RequisitionFileAttachment", "RequisitionStatus", "RequisitionStatusChange", "RequisitionStatusAttribute", "RequisitionStatusDocument", "RequisitionStatusChangeHistory", "RequisitionItemTransaction", "ApprovalRole", "RequisitionAttribute", "RequisitionDocument", "RequisitionTransaction", "RequisitionItem", "RequisitionItemFileAttachment", "UserSiteApprovalRole", "ApprovalWorkflow", "ApprovalWorkflowExpression", "ApprovalWorkflowExpressionApprovalRole", "Competency", "Resource", "ResourceAttribute", "ResourceAddress", "ResourceClassification", "ResourceCompetency", "ResourceDocument", "ResourceEmail", "ResourcePhoneNumber", "ResourceTrade", "ResourceTradeCompetency", "ResourceTradeFinancialRate", "Section", "SectionAttribute", "SectionDocument", "SectionTrade", "TradeAttribute", "TradeDocument", "Trade", "TradeCompetency", "TradeFinancialRate", "ResourceContext", "ResourceFileAttachment", "AssetImportance", "RiskConsequence", "RiskConsequenceCategory", "RiskModel", "RiskModelConsequenceCategory", "RiskModelImportance", "RiskModelProbability", "RiskProbability", "WorkOrderImportance", "WorkOrderStatus", "WorkOrderStatusAttribute", "WorkOrderStatusDocument", "WorkOrderStatusAllowedChange", "WorkOrder", "WorkOrderStatusChangeHistory", "WorkOrderStatusChange", "WorkOrderMerge", "WorkOrderSplit", "WorkOrderMeter", "WorkOrderAttribute", "WorkOrderDocument", "WorkOrderFileAttachment", "WorkOrderTaskFileAttachment", "WorkOrderTaskWarranty", "WorkOrderTaskSpareFileAttachment", "WorkOrderTask", "WorkOrderTaskDocument", "WorkOrderTaskAdHocCost", "WorkOrderMonitoringPoint", "WorkOrderTaskMonitoringPoint", "WorkOrderTaskSpare", "WorkOrderTaskSubTask", "WorkOrderTaskResource", "WorkOrderTaskResourceUsage", "DueTask", "DueTaskSuppressor", "ProposedWorkOrderBatch", "ProposedWorkOrder", "ProposedWorkOrderTask", "ProposedWorkOrderMeter", "WorkOrderMovement", "WorkOrderTaskMovement", "WorkOrderTaskResourceMovement", "WorkOrderTaskSpareMovement", "WorkOrderTaskSubTaskMovement", "WorkOrderCompleteAllTasksLog", "WorkRequest", "WorkRequestAttribute", "WorkRequestDocument", "WorkRequestStatus", "WorkRequestStatusChange", "WorkRequestStatusChangeHistory", "WorkRequestFileAttachment", "WorkOrderDowntimeLoss", "WorkOrderProgressEvent", "WorkOrderProgressEventAllowedChange", "WorkOrderProgressLog", "WorkOrderWarranty", "ServiceLevelAgreementClassification", "ServiceLevelAgreement", "ServiceLevelAgreementMeasure", "WorkOrderServiceLevelAgreement", "WorkOrderServiceLevelAgreementMeasure", "ServiceLevelAgreementMeasureTrigger", "ServiceLevelAgreementMeasureFieldAssignment", "PermissionTree", "User", "UserAttribute", "UserDocument", "UserAuthentication", "SecurityRole", "SecurityRolePermission", "UserSecurityRole", "UserCustomPermission", "UserOption", "BackgroundTask", "BackgroundTaskStep", "ScheduledBackgroundTask", "ScheduledJob", "UserDefinedField", "UserDefinedFieldPredefinedValue", "SystemOption", "SystemOptionPageLimit", "SystemOptionWorkOrderStatus", "SystemOptionDefaultStandardTask", "SystemOptionWorkOrderStatusTypeOfWork", "SystemOptionReferenceDataViewPermission", "SystemOptionFileAttachmentCategory", "SystemOptionFileAttachmentFileType", "RecordChange", "RecordChangeValue", "RecordChangeUser", "RecordChangeProperty", "NotificationEventOutbox", "NotificationEventAttachmentOutbox", "NotificationOutbox", "NotificationOutboxLog", "ChangeDataTriggerCriteriaEvaluation", "SystemOptionReportServerEntity", "SystemOptionReportServerEntityDefaultReport", "TemplateMigrationLog", "TemplateMigrationLogIntent", "ResourceActionMigrationLog", "ImportSchema", "ImportFile", "UserDefinedQuery", "ResourceActionCustomisation", "TemplateCustomisation", "TemplateResource", "ClusterSettings", "ClusterIdentityProviderSettings", "MessageBrokerHost", "MessageBrokerTopic", "MessageBrokerTopicConsumer", "TenantSettings", "TenantChangeDataSubscriptionSettings", "TenantIdentityProviderSettings", "TenantJobSettings", "TenantFileContentStoreLocationSettings", "TenantFileContentStoreFileTypeGroupSettings", "TenantFileContentStoreFileTypeSettings", "ClusterFeatureToggle", "TenantFeatureToggle", "TenantHealthCheck", "TenantMachineHealthCheck", "ClusterHealthCheck", "ClusterMachineHealthCheck", "ClusterCapacitySlot", "TenantChangeLogCleanupExpressionSettings", "ClusterJobSettings", "Ignore" ] } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report", "schema": { "$ref": "#/definitions/GetReportServerIntegrationTokenResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/Url": { "get": { "tags": [ "Report" ], "summary": "Get the Report Server Url to view the Integration Portal for the current authenticated user", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| url | ReportServerUrl->Url | string | |\r\n| type | ReportServerUrl->Type | string (Allowed values: [Base, ResourcePortal, IntegrationPortal, IntegrationAdminPortal, ViewReport]) | enum |\r\n", "operationId": "GetReportServerUrl", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report", "schema": { "$ref": "#/definitions/GetReportUrlResourceActionResponse2" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/ViewReportUrl": { "get": { "tags": [ "Report" ], "summary": "Get the Report Server Url to view a Report for the current authenticated user", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| url | ReportServerUrl->Url | string | |\r\n| type | ReportServerUrl->Type | string (Allowed values: [Base, ResourcePortal, IntegrationPortal, IntegrationAdminPortal, ViewReport]) | enum |\r\n", "operationId": "GetReportServerViewReportUrl", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report", "schema": { "$ref": "#/definitions/GetViewReportUrlResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/Dashboards": { "get": { "tags": [ "Report" ], "summary": "Get a list of Report Server Dashboard 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 | ReportServerDashboard->Id | string | |\r\n| title | ReportServerDashboard->Title | string | |\r\n| description | ReportServerDashboard->Description | string | |\r\n| category | ReportServerDashboard->Category | string | |\r\n", "operationId": "GetReportServerDashboards", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "EntityType", "in": "query", "description": "Filter reports by Entity Type", "x-schema": { "$ref": "#/definitions/EntityType" }, "x-nullable": true, "enum": [ "Alarm", "NewAlarm", "AlarmExpression", "AlarmExpressionTask", "AlarmAttribute", "AlarmDocument", "AlarmType", "MonitoringPoint", "MonitoringPointBoundEvaluationLog", "MonitoringPointParameter", "MonitoringPointReading", "MonitoringPointTrigger", "MonitoringPointTriggerExpression", "MonitoringPointTriggerExpressionAlarmType", "MonitoringPointTriggerExpressionParameter", "MonitoringPointTriggerExpressionEvaluation", "MonitoringPointTriggerExpressionEvaluationLog", "MonitoringPointType", "MonitoringPointTypeParameter", "MonitoringPointAttribute", "MonitoringPointDocument", "AuxiliaryAssetTask", "AuxiliaryAssetTaskResource", "AuxiliaryAssetTaskSpare", "AuxiliaryAssetTaskSubTask", "RegularAssetComponent", "RegularAssetComponentAttribute", "RegularAssetComponentDocument", "RegularAssetComponentRuleEvaluationFailure", "AssetComponent", "AssetWarranty", "PlaceholderAssetComponent", "PlaceholderAssetComponentOptionValue", "PlaceholderAssetComponentCondition", "PlaceholderAssetMeter", "PlaceholderAssetComponentRuleEvaluationFailure", "RegularAssetCondition", "RegularAssetActiveCondition", "AssetFmeca", "RegularAssetOptionValue", "Asset", "RegularAssetAttribute", "RegularAssetDocument", "RegularAssetFileAttachment", "PlaceholderAsset", "PlaceholderAssetAttribute", "PlaceholderAssetDocument", "PlaceholderAssetFileAttachment", "PlaceholderAssetRuleEvaluationFailure", "PlaceholderAssetResponsibility", "PlaceholderAssetCondition", "PlaceholderAssetActiveCondition", "AssetTask", "SetAssetTaskSpareWarehouseEntity", "RegularAssetTask", "RegularAssetTaskRuleEvaluationFailure", "RegularAssetTaskAttribute", "RegularAssetTaskAuxiliaryTask", "RegularAssetTaskFollowUpTask", "RegularAssetTaskFollowUpTaskExpression", "RegularAssetTaskSuppressedTask", "RegularAssetTaskResource", "RegularAssetTaskResourceRuleEvaluationFailure", "RegularAssetTaskSpare", "RegularAssetTaskSpareRuleEvaluationFailure", "RegularAssetTaskSubTask", "RegularAssetTaskFileAttachment", "AuxiliaryAssetTypeTask", "AuxiliaryAssetTypeTaskResource", "AuxiliaryAssetTypeTaskSpare", "AuxiliaryAssetTypeTaskSubTask", "RegularAssetTypeComponent", "RegularAssetTypeComponentAttribute", "RegularAssetTypeComponentDocument", "AssetTypeComponent", "PlaceholderAssetTypeComponent", "PlaceholderAssetTypeComponentCondition", "PlaceholderAssetTypeComponentAttribute", "PlaceholderAssetTypeComponentDocument", "PlaceholderAssetTypeComponentRuleLink", "RegularAssetTypeComponentRuleLink", "PlaceholderAssetComponentAttribute", "PlaceholderAssetComponentDocument", "PlaceholderAssetComponentActiveCondition", "AssetTypeFmeca", "AssetTypeFunction", "AssetFunction", "AssetFmecaTask", "AssetTypeFmecaTask", "AssetTypeFolder", "RegularAssetTypeOption", "AssetType", "PlaceholderAssetType", "PlaceholderAssetTypeSpare", "PlaceholderAssetTypeAttribute", "PlaceholderAssetTypeDocument", "PlaceholderAssetTypeResponsibility", "PlaceholderAssetTypeRuleLink", "RegularAssetTypeTask", "RegularAssetTypeTaskAttribute", "RegularAssetTypeTaskAuxiliaryTask", "RegularAssetTypeTaskCondition", "RegularAssetTypeTaskDocument", "RegularAssetTypeTaskFollowUpTask", "RegularAssetTypeTaskFollowUpTaskExpression", "AssetTypeTask", "AssetTypeTaskResource", "AssetTaskResource", "AssetTaskSpare", "AssetTypeTaskSpare", "RegularAssetTypeTaskResource", "RegularAssetTypeTaskRuleLink", "RegularAssetTypeTaskSpare", "RegularAssetTypeTaskSubTask", "RegularAssetTypeTaskSuppressedTask", "Condition", "ConditionType", "Event", "FailureCause", "FailureCauseType", "FailureMechanism", "FailureMechanismType", "FailureMode", "FailureModeType", "InPlaceAssetMeter", "InPlaceAssetAttribute", "InPlaceAssetFileAttachment", "InPlaceAssetRuleEvaluationFailure", "InPlaceAssetResponsibility", "InPlaceAssetSpare", "InPlaceAssetType", "InPlaceAssetTypeResponsibility", "InPlaceAssetTypeRuleLink", "InPlaceAssetTypeSpare", "InPlaceAsset", "Option", "OptionCategory", "RegularAsset", "RegularAssetTaskDocument", "RegularAssetMeter", "RegularAssetResponsibility", "RegularAssetMonitoringPointTrigger", "RegularAssetSpare", "RegularAssetTaskCondition", "RegularAssetType", "RegularAssetTypeAttribute", "RegularAssetTypeDocument", "RegularAssetTypeCondition", "PlaceholderAssetTypeCondition", "RegularAssetTypeRule", "RegularAssetTypeResponsibility", "RegularAssetTypeMonitoringPointTrigger", "RegularAssetTypeSpare", "RepairType", "Rule", "RuleCategory", "RuleOption", "StandardTask", "StandardTaskSpare", "StandardTaskSubTask", "StandardTaskResource", "StandardTaskAttribute", "StandardTaskDocument", "TaskImportance", "TaskInterval", "TaskIntervalType", "TaskRollUpPoint", "TypeOfWork", "RegularAssetTypeTaskSpareRuleLink", "InPlaceAssetTypeAttribute", "RegularAssetTypeTaskResourceRuleLink", "PlaceholderAssetSpare", "RegularAssetMonitoringPointTriggerParameter", "AssetSpare", "AssetTypeSpare", "AssetMeter", "AssetConsumption", "RegularAssetConsumption", "PlaceholderAssetConsumption", "InPlaceAssetConsumption", "WarrantyType", "RegularAssetTypeFileAttachment", "Meter", "MeterAttribute", "MeterDocument", "MeterReading", "PredictedMeterReading", "TimeLossCategory", "TimeLossReason", "TimeLossType", "Consumable", "AcquisitionStatus", "AcquisitionType", "DocumentFolder", "DocumentRecord", "DocumentRecordAttribute", "FileAttachment", "FileAttachmentCategory", "FileAttachmentContentHistory", "DocumentRecordFileHistory", "Costing", "CostingBudget", "CostCentre", "CostCentreAttribute", "CostCentreDocument", "CostCentreType", "CostElement", "CostElementAttribute", "CostElementDocument", "Currency", "BudgetTemplate", "BudgetTemplateParameter", "FinancialYear", "FinancialYearPeriod", "GeneralLedger", "GeneralLedgerAttribute", "GeneralLedgerDocument", "CurrencyRate", "Budget", "BudgetParameter", "AddressType", "Approval", "Attribute", "AttributeAllowedValue", "Calendar", "CalendarDay", "CalendarException", "CalendarDayHour", "Classification", "ClassificationAllowedValue", "EmailType", "Language", "OperationalRole", "OperationalRoleTemplate", "OperationalRoleResource", "PhoneNumberType", "UserOperationalRole", "UserOperationalRoleTemplate", "UserOperationalRoleResource", "TermsAndCondition", "TermsAndConditionVersion", "TermsAndConditionOperationalRole", "UserTermsAndConditionVersion", "Location", "LocationAttribute", "LocationDocument", "LocalisationSet", "LocalisationKey", "LocalisationTranslation", "Phrase", "PhraseTranslation", "PreconfiguredReason", "Site", "SiteAttribute", "SiteDocument", "SiteType", "Supplier", "SupplierFileAttachment", "SupplierAttribute", "SupplierDocument", "SupplierContactAddress", "SupplierContactEmail", "SupplierContactPhoneNumber", "SupplierResource", "SupplierTaxRate", "UnitOfMeasurement", "SiteResource", "SiteContactAddress", "SiteContactEmail", "SiteContactPhoneNumber", "ChangeDataTrigger", "ChangeDataTriggerOccurrenceLog", "ChangeDataTriggerCriteria", "NotificationTemplate", "ChangeDataTriggerCriteriaParameter", "ChangeDataTriggerNotificationEvent", "NotificationTemplateParameter", "ChangeDataTriggerNotificationEventAttachment", "ChangeDataTriggerNotificationEventAttachmentParameter", "RequestType", "Category", "Commodity", "MaterialMaster", "MaterialMasterAttribute", "MaterialMasterDocument", "MaterialMasterBin", "MaterialMasterSupplier", "MaterialMasterLinkWarehouse", "StockItem", "StockItemFileAttachment", "StockItemAttribute", "StockItemDocument", "StockItemBin", "StockItemSupplier", "WarehouseAttribute", "Warehouse", "WarehouseDocument", "Requisition", "RequisitionFileAttachment", "RequisitionStatus", "RequisitionStatusChange", "RequisitionStatusAttribute", "RequisitionStatusDocument", "RequisitionStatusChangeHistory", "RequisitionItemTransaction", "ApprovalRole", "RequisitionAttribute", "RequisitionDocument", "RequisitionTransaction", "RequisitionItem", "RequisitionItemFileAttachment", "UserSiteApprovalRole", "ApprovalWorkflow", "ApprovalWorkflowExpression", "ApprovalWorkflowExpressionApprovalRole", "Competency", "Resource", "ResourceAttribute", "ResourceAddress", "ResourceClassification", "ResourceCompetency", "ResourceDocument", "ResourceEmail", "ResourcePhoneNumber", "ResourceTrade", "ResourceTradeCompetency", "ResourceTradeFinancialRate", "Section", "SectionAttribute", "SectionDocument", "SectionTrade", "TradeAttribute", "TradeDocument", "Trade", "TradeCompetency", "TradeFinancialRate", "ResourceContext", "ResourceFileAttachment", "AssetImportance", "RiskConsequence", "RiskConsequenceCategory", "RiskModel", "RiskModelConsequenceCategory", "RiskModelImportance", "RiskModelProbability", "RiskProbability", "WorkOrderImportance", "WorkOrderStatus", "WorkOrderStatusAttribute", "WorkOrderStatusDocument", "WorkOrderStatusAllowedChange", "WorkOrder", "WorkOrderStatusChangeHistory", "WorkOrderStatusChange", "WorkOrderMerge", "WorkOrderSplit", "WorkOrderMeter", "WorkOrderAttribute", "WorkOrderDocument", "WorkOrderFileAttachment", "WorkOrderTaskFileAttachment", "WorkOrderTaskWarranty", "WorkOrderTaskSpareFileAttachment", "WorkOrderTask", "WorkOrderTaskDocument", "WorkOrderTaskAdHocCost", "WorkOrderMonitoringPoint", "WorkOrderTaskMonitoringPoint", "WorkOrderTaskSpare", "WorkOrderTaskSubTask", "WorkOrderTaskResource", "WorkOrderTaskResourceUsage", "DueTask", "DueTaskSuppressor", "ProposedWorkOrderBatch", "ProposedWorkOrder", "ProposedWorkOrderTask", "ProposedWorkOrderMeter", "WorkOrderMovement", "WorkOrderTaskMovement", "WorkOrderTaskResourceMovement", "WorkOrderTaskSpareMovement", "WorkOrderTaskSubTaskMovement", "WorkOrderCompleteAllTasksLog", "WorkRequest", "WorkRequestAttribute", "WorkRequestDocument", "WorkRequestStatus", "WorkRequestStatusChange", "WorkRequestStatusChangeHistory", "WorkRequestFileAttachment", "WorkOrderDowntimeLoss", "WorkOrderProgressEvent", "WorkOrderProgressEventAllowedChange", "WorkOrderProgressLog", "WorkOrderWarranty", "ServiceLevelAgreementClassification", "ServiceLevelAgreement", "ServiceLevelAgreementMeasure", "WorkOrderServiceLevelAgreement", "WorkOrderServiceLevelAgreementMeasure", "ServiceLevelAgreementMeasureTrigger", "ServiceLevelAgreementMeasureFieldAssignment", "PermissionTree", "User", "UserAttribute", "UserDocument", "UserAuthentication", "SecurityRole", "SecurityRolePermission", "UserSecurityRole", "UserCustomPermission", "UserOption", "BackgroundTask", "BackgroundTaskStep", "ScheduledBackgroundTask", "ScheduledJob", "UserDefinedField", "UserDefinedFieldPredefinedValue", "SystemOption", "SystemOptionPageLimit", "SystemOptionWorkOrderStatus", "SystemOptionDefaultStandardTask", "SystemOptionWorkOrderStatusTypeOfWork", "SystemOptionReferenceDataViewPermission", "SystemOptionFileAttachmentCategory", "SystemOptionFileAttachmentFileType", "RecordChange", "RecordChangeValue", "RecordChangeUser", "RecordChangeProperty", "NotificationEventOutbox", "NotificationEventAttachmentOutbox", "NotificationOutbox", "NotificationOutboxLog", "ChangeDataTriggerCriteriaEvaluation", "SystemOptionReportServerEntity", "SystemOptionReportServerEntityDefaultReport", "TemplateMigrationLog", "TemplateMigrationLogIntent", "ResourceActionMigrationLog", "ImportSchema", "ImportFile", "UserDefinedQuery", "ResourceActionCustomisation", "TemplateCustomisation", "TemplateResource", "ClusterSettings", "ClusterIdentityProviderSettings", "MessageBrokerHost", "MessageBrokerTopic", "MessageBrokerTopicConsumer", "TenantSettings", "TenantChangeDataSubscriptionSettings", "TenantIdentityProviderSettings", "TenantJobSettings", "TenantFileContentStoreLocationSettings", "TenantFileContentStoreFileTypeGroupSettings", "TenantFileContentStoreFileTypeSettings", "ClusterFeatureToggle", "TenantFeatureToggle", "TenantHealthCheck", "TenantMachineHealthCheck", "ClusterHealthCheck", "ClusterMachineHealthCheck", "ClusterCapacitySlot", "TenantChangeLogCleanupExpressionSettings", "ClusterJobSettings", "Ignore" ] } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report collection", "schema": { "$ref": "#/definitions/GetReportServerDashboardsResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/ReportLanguages": { "get": { "tags": [ "Report" ], "summary": "Get a list of Report Server Report Language 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| name | ReportServerReportLanguage->Name | string | |\r\n| displayName | ReportServerReportLanguage->DisplayName | string | |\r\n", "operationId": "GetReportServerReportLanguages", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report collection", "schema": { "$ref": "#/definitions/GetReportServerReportLanguageResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/Reports": { "get": { "tags": [ "Report" ], "summary": "Get a list of Report Server Report resources", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ReportServerReport->Id | string | |\r\n| title | ReportServerReport->Title | string | |\r\n| description | ReportServerReport->Description | string | |\r\n| category | ReportServerReport->Category | string | |\r\n", "operationId": "GetReportServerReports", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "EntityType", "in": "query", "description": "Filter reports by Entity Type", "x-schema": { "$ref": "#/definitions/EntityType" }, "x-nullable": true, "enum": [ "Alarm", "NewAlarm", "AlarmExpression", "AlarmExpressionTask", "AlarmAttribute", "AlarmDocument", "AlarmType", "MonitoringPoint", "MonitoringPointBoundEvaluationLog", "MonitoringPointParameter", "MonitoringPointReading", "MonitoringPointTrigger", "MonitoringPointTriggerExpression", "MonitoringPointTriggerExpressionAlarmType", "MonitoringPointTriggerExpressionParameter", "MonitoringPointTriggerExpressionEvaluation", "MonitoringPointTriggerExpressionEvaluationLog", "MonitoringPointType", "MonitoringPointTypeParameter", "MonitoringPointAttribute", "MonitoringPointDocument", "AuxiliaryAssetTask", "AuxiliaryAssetTaskResource", "AuxiliaryAssetTaskSpare", "AuxiliaryAssetTaskSubTask", "RegularAssetComponent", "RegularAssetComponentAttribute", "RegularAssetComponentDocument", "RegularAssetComponentRuleEvaluationFailure", "AssetComponent", "AssetWarranty", "PlaceholderAssetComponent", "PlaceholderAssetComponentOptionValue", "PlaceholderAssetComponentCondition", "PlaceholderAssetMeter", "PlaceholderAssetComponentRuleEvaluationFailure", "RegularAssetCondition", "RegularAssetActiveCondition", "AssetFmeca", "RegularAssetOptionValue", "Asset", "RegularAssetAttribute", "RegularAssetDocument", "RegularAssetFileAttachment", "PlaceholderAsset", "PlaceholderAssetAttribute", "PlaceholderAssetDocument", "PlaceholderAssetFileAttachment", "PlaceholderAssetRuleEvaluationFailure", "PlaceholderAssetResponsibility", "PlaceholderAssetCondition", "PlaceholderAssetActiveCondition", "AssetTask", "SetAssetTaskSpareWarehouseEntity", "RegularAssetTask", "RegularAssetTaskRuleEvaluationFailure", "RegularAssetTaskAttribute", "RegularAssetTaskAuxiliaryTask", "RegularAssetTaskFollowUpTask", "RegularAssetTaskFollowUpTaskExpression", "RegularAssetTaskSuppressedTask", "RegularAssetTaskResource", "RegularAssetTaskResourceRuleEvaluationFailure", "RegularAssetTaskSpare", "RegularAssetTaskSpareRuleEvaluationFailure", "RegularAssetTaskSubTask", "RegularAssetTaskFileAttachment", "AuxiliaryAssetTypeTask", "AuxiliaryAssetTypeTaskResource", "AuxiliaryAssetTypeTaskSpare", "AuxiliaryAssetTypeTaskSubTask", "RegularAssetTypeComponent", "RegularAssetTypeComponentAttribute", "RegularAssetTypeComponentDocument", "AssetTypeComponent", "PlaceholderAssetTypeComponent", "PlaceholderAssetTypeComponentCondition", "PlaceholderAssetTypeComponentAttribute", "PlaceholderAssetTypeComponentDocument", "PlaceholderAssetTypeComponentRuleLink", "RegularAssetTypeComponentRuleLink", "PlaceholderAssetComponentAttribute", "PlaceholderAssetComponentDocument", "PlaceholderAssetComponentActiveCondition", "AssetTypeFmeca", "AssetTypeFunction", "AssetFunction", "AssetFmecaTask", "AssetTypeFmecaTask", "AssetTypeFolder", "RegularAssetTypeOption", "AssetType", "PlaceholderAssetType", "PlaceholderAssetTypeSpare", "PlaceholderAssetTypeAttribute", "PlaceholderAssetTypeDocument", "PlaceholderAssetTypeResponsibility", "PlaceholderAssetTypeRuleLink", "RegularAssetTypeTask", "RegularAssetTypeTaskAttribute", "RegularAssetTypeTaskAuxiliaryTask", "RegularAssetTypeTaskCondition", "RegularAssetTypeTaskDocument", "RegularAssetTypeTaskFollowUpTask", "RegularAssetTypeTaskFollowUpTaskExpression", "AssetTypeTask", "AssetTypeTaskResource", "AssetTaskResource", "AssetTaskSpare", "AssetTypeTaskSpare", "RegularAssetTypeTaskResource", "RegularAssetTypeTaskRuleLink", "RegularAssetTypeTaskSpare", "RegularAssetTypeTaskSubTask", "RegularAssetTypeTaskSuppressedTask", "Condition", "ConditionType", "Event", "FailureCause", "FailureCauseType", "FailureMechanism", "FailureMechanismType", "FailureMode", "FailureModeType", "InPlaceAssetMeter", "InPlaceAssetAttribute", "InPlaceAssetFileAttachment", "InPlaceAssetRuleEvaluationFailure", "InPlaceAssetResponsibility", "InPlaceAssetSpare", "InPlaceAssetType", "InPlaceAssetTypeResponsibility", "InPlaceAssetTypeRuleLink", "InPlaceAssetTypeSpare", "InPlaceAsset", "Option", "OptionCategory", "RegularAsset", "RegularAssetTaskDocument", "RegularAssetMeter", "RegularAssetResponsibility", "RegularAssetMonitoringPointTrigger", "RegularAssetSpare", "RegularAssetTaskCondition", "RegularAssetType", "RegularAssetTypeAttribute", "RegularAssetTypeDocument", "RegularAssetTypeCondition", "PlaceholderAssetTypeCondition", "RegularAssetTypeRule", "RegularAssetTypeResponsibility", "RegularAssetTypeMonitoringPointTrigger", "RegularAssetTypeSpare", "RepairType", "Rule", "RuleCategory", "RuleOption", "StandardTask", "StandardTaskSpare", "StandardTaskSubTask", "StandardTaskResource", "StandardTaskAttribute", "StandardTaskDocument", "TaskImportance", "TaskInterval", "TaskIntervalType", "TaskRollUpPoint", "TypeOfWork", "RegularAssetTypeTaskSpareRuleLink", "InPlaceAssetTypeAttribute", "RegularAssetTypeTaskResourceRuleLink", "PlaceholderAssetSpare", "RegularAssetMonitoringPointTriggerParameter", "AssetSpare", "AssetTypeSpare", "AssetMeter", "AssetConsumption", "RegularAssetConsumption", "PlaceholderAssetConsumption", "InPlaceAssetConsumption", "WarrantyType", "RegularAssetTypeFileAttachment", "Meter", "MeterAttribute", "MeterDocument", "MeterReading", "PredictedMeterReading", "TimeLossCategory", "TimeLossReason", "TimeLossType", "Consumable", "AcquisitionStatus", "AcquisitionType", "DocumentFolder", "DocumentRecord", "DocumentRecordAttribute", "FileAttachment", "FileAttachmentCategory", "FileAttachmentContentHistory", "DocumentRecordFileHistory", "Costing", "CostingBudget", "CostCentre", "CostCentreAttribute", "CostCentreDocument", "CostCentreType", "CostElement", "CostElementAttribute", "CostElementDocument", "Currency", "BudgetTemplate", "BudgetTemplateParameter", "FinancialYear", "FinancialYearPeriod", "GeneralLedger", "GeneralLedgerAttribute", "GeneralLedgerDocument", "CurrencyRate", "Budget", "BudgetParameter", "AddressType", "Approval", "Attribute", "AttributeAllowedValue", "Calendar", "CalendarDay", "CalendarException", "CalendarDayHour", "Classification", "ClassificationAllowedValue", "EmailType", "Language", "OperationalRole", "OperationalRoleTemplate", "OperationalRoleResource", "PhoneNumberType", "UserOperationalRole", "UserOperationalRoleTemplate", "UserOperationalRoleResource", "TermsAndCondition", "TermsAndConditionVersion", "TermsAndConditionOperationalRole", "UserTermsAndConditionVersion", "Location", "LocationAttribute", "LocationDocument", "LocalisationSet", "LocalisationKey", "LocalisationTranslation", "Phrase", "PhraseTranslation", "PreconfiguredReason", "Site", "SiteAttribute", "SiteDocument", "SiteType", "Supplier", "SupplierFileAttachment", "SupplierAttribute", "SupplierDocument", "SupplierContactAddress", "SupplierContactEmail", "SupplierContactPhoneNumber", "SupplierResource", "SupplierTaxRate", "UnitOfMeasurement", "SiteResource", "SiteContactAddress", "SiteContactEmail", "SiteContactPhoneNumber", "ChangeDataTrigger", "ChangeDataTriggerOccurrenceLog", "ChangeDataTriggerCriteria", "NotificationTemplate", "ChangeDataTriggerCriteriaParameter", "ChangeDataTriggerNotificationEvent", "NotificationTemplateParameter", "ChangeDataTriggerNotificationEventAttachment", "ChangeDataTriggerNotificationEventAttachmentParameter", "RequestType", "Category", "Commodity", "MaterialMaster", "MaterialMasterAttribute", "MaterialMasterDocument", "MaterialMasterBin", "MaterialMasterSupplier", "MaterialMasterLinkWarehouse", "StockItem", "StockItemFileAttachment", "StockItemAttribute", "StockItemDocument", "StockItemBin", "StockItemSupplier", "WarehouseAttribute", "Warehouse", "WarehouseDocument", "Requisition", "RequisitionFileAttachment", "RequisitionStatus", "RequisitionStatusChange", "RequisitionStatusAttribute", "RequisitionStatusDocument", "RequisitionStatusChangeHistory", "RequisitionItemTransaction", "ApprovalRole", "RequisitionAttribute", "RequisitionDocument", "RequisitionTransaction", "RequisitionItem", "RequisitionItemFileAttachment", "UserSiteApprovalRole", "ApprovalWorkflow", "ApprovalWorkflowExpression", "ApprovalWorkflowExpressionApprovalRole", "Competency", "Resource", "ResourceAttribute", "ResourceAddress", "ResourceClassification", "ResourceCompetency", "ResourceDocument", "ResourceEmail", "ResourcePhoneNumber", "ResourceTrade", "ResourceTradeCompetency", "ResourceTradeFinancialRate", "Section", "SectionAttribute", "SectionDocument", "SectionTrade", "TradeAttribute", "TradeDocument", "Trade", "TradeCompetency", "TradeFinancialRate", "ResourceContext", "ResourceFileAttachment", "AssetImportance", "RiskConsequence", "RiskConsequenceCategory", "RiskModel", "RiskModelConsequenceCategory", "RiskModelImportance", "RiskModelProbability", "RiskProbability", "WorkOrderImportance", "WorkOrderStatus", "WorkOrderStatusAttribute", "WorkOrderStatusDocument", "WorkOrderStatusAllowedChange", "WorkOrder", "WorkOrderStatusChangeHistory", "WorkOrderStatusChange", "WorkOrderMerge", "WorkOrderSplit", "WorkOrderMeter", "WorkOrderAttribute", "WorkOrderDocument", "WorkOrderFileAttachment", "WorkOrderTaskFileAttachment", "WorkOrderTaskWarranty", "WorkOrderTaskSpareFileAttachment", "WorkOrderTask", "WorkOrderTaskDocument", "WorkOrderTaskAdHocCost", "WorkOrderMonitoringPoint", "WorkOrderTaskMonitoringPoint", "WorkOrderTaskSpare", "WorkOrderTaskSubTask", "WorkOrderTaskResource", "WorkOrderTaskResourceUsage", "DueTask", "DueTaskSuppressor", "ProposedWorkOrderBatch", "ProposedWorkOrder", "ProposedWorkOrderTask", "ProposedWorkOrderMeter", "WorkOrderMovement", "WorkOrderTaskMovement", "WorkOrderTaskResourceMovement", "WorkOrderTaskSpareMovement", "WorkOrderTaskSubTaskMovement", "WorkOrderCompleteAllTasksLog", "WorkRequest", "WorkRequestAttribute", "WorkRequestDocument", "WorkRequestStatus", "WorkRequestStatusChange", "WorkRequestStatusChangeHistory", "WorkRequestFileAttachment", "WorkOrderDowntimeLoss", "WorkOrderProgressEvent", "WorkOrderProgressEventAllowedChange", "WorkOrderProgressLog", "WorkOrderWarranty", "ServiceLevelAgreementClassification", "ServiceLevelAgreement", "ServiceLevelAgreementMeasure", "WorkOrderServiceLevelAgreement", "WorkOrderServiceLevelAgreementMeasure", "ServiceLevelAgreementMeasureTrigger", "ServiceLevelAgreementMeasureFieldAssignment", "PermissionTree", "User", "UserAttribute", "UserDocument", "UserAuthentication", "SecurityRole", "SecurityRolePermission", "UserSecurityRole", "UserCustomPermission", "UserOption", "BackgroundTask", "BackgroundTaskStep", "ScheduledBackgroundTask", "ScheduledJob", "UserDefinedField", "UserDefinedFieldPredefinedValue", "SystemOption", "SystemOptionPageLimit", "SystemOptionWorkOrderStatus", "SystemOptionDefaultStandardTask", "SystemOptionWorkOrderStatusTypeOfWork", "SystemOptionReferenceDataViewPermission", "SystemOptionFileAttachmentCategory", "SystemOptionFileAttachmentFileType", "RecordChange", "RecordChangeValue", "RecordChangeUser", "RecordChangeProperty", "NotificationEventOutbox", "NotificationEventAttachmentOutbox", "NotificationOutbox", "NotificationOutboxLog", "ChangeDataTriggerCriteriaEvaluation", "SystemOptionReportServerEntity", "SystemOptionReportServerEntityDefaultReport", "TemplateMigrationLog", "TemplateMigrationLogIntent", "ResourceActionMigrationLog", "ImportSchema", "ImportFile", "UserDefinedQuery", "ResourceActionCustomisation", "TemplateCustomisation", "TemplateResource", "ClusterSettings", "ClusterIdentityProviderSettings", "MessageBrokerHost", "MessageBrokerTopic", "MessageBrokerTopicConsumer", "TenantSettings", "TenantChangeDataSubscriptionSettings", "TenantIdentityProviderSettings", "TenantJobSettings", "TenantFileContentStoreLocationSettings", "TenantFileContentStoreFileTypeGroupSettings", "TenantFileContentStoreFileTypeSettings", "ClusterFeatureToggle", "TenantFeatureToggle", "TenantHealthCheck", "TenantMachineHealthCheck", "ClusterHealthCheck", "ClusterMachineHealthCheck", "ClusterCapacitySlot", "TenantChangeLogCleanupExpressionSettings", "ClusterJobSettings", "Ignore" ] } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report collection", "schema": { "$ref": "#/definitions/GetReportServerReportsResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/Roles": { "get": { "tags": [ "Report" ], "summary": "Get a list of Report Server Role 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| name | ReportServerRole->Name | string | |\r\n", "operationId": "GetReportServerRoles", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report collection", "schema": { "$ref": "#/definitions/GetReportServerRolesResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/Tags": { "get": { "tags": [ "Report" ], "summary": "Get a list of Report Server Tag 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 | ReportServerTag->Id | string | |\r\n| parentId | ReportServerTag->ParentId | string | |\r\n| name | ReportServerTag->Name | string | |\r\n| color | ReportServerTag->Color | string | |\r\n| documentCount | ReportServerTag->DocumentCount | integer | int64 |\r\n| isFavorites | ReportServerTag->IsFavorites | boolean | |\r\n| order | ReportServerTag->Order | integer | int64 |\r\n", "operationId": "GetReportServerTags", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report collection", "schema": { "$ref": "#/definitions/GetReportServerTagsResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/Reports/ReportServer/UserInterfaceLanguages": { "get": { "tags": [ "Report" ], "summary": "Get a list of Report Server Report Language 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| name | ReportServerReportLanguage->Name | string | |\r\n| displayName | ReportServerReportLanguage->DisplayName | string | |\r\n", "operationId": "GetReportServerUserInterfaceLanguages", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Report collection", "schema": { "$ref": "#/definitions/GetReportServerUserInterfaceLanguageResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries/{id}": { "get": { "tags": [ "User Defined Query" ], "summary": "Get a User Defined Query resource.", "description": "### Response Body\r\n#### 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 | UserDefinedQuery->Code | string | |\r\n| isActive | UserDefinedQuery->IsActive | boolean | |\r\n| createdByUserId | UserDefinedQuery->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserDefinedQuery->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserDefinedQuery->CreatedByUser_FullName | string | |\r\n| createdOn | UserDefinedQuery->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserDefinedQuery->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserDefinedQuery->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserDefinedQuery->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserDefinedQuery->ModifiedOn | string | date-time |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n| permissionTreeId | UserDefinedQuery->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserDefinedQuery->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserDefinedQuery->PermissionTree_Description | string | |\r\n| id | UserDefinedQuery->Id | integer | int64 |\r\n| addPermissionFilter | UserDefinedQuery->AddPermissionFilter | boolean | |\r\n| description | UserDefinedQuery->Description | string | |\r\n| entity | UserDefinedQuery->Entity | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| isRunnable | UserDefinedQuery->IsRunnable | boolean | |\r\n| notes | UserDefinedQuery->Notes | string | |\r\n| query | UserDefinedQuery->Query | object | |\r\n| sequenceNumber | UserDefinedQuery->SequenceNumber | integer | int32 |\r\n", "operationId": "GetUserDefinedQuery", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Query Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Defined Query", "schema": { "$ref": "#/definitions/GetUserDefinedQueryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Defined Query" ], "summary": "Update an existing User Defined Query resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n| code | UserDefinedQuery->Code | string | |\r\n| description | UserDefinedQuery->Description | string | |\r\n| entity | UserDefinedQuery->Entity | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| addPermissionFilter | UserDefinedQuery->AddPermissionFilter | boolean | |\r\n| query | UserDefinedQuery->Query | object | |\r\n| notes | UserDefinedQuery->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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 | <= 500 chars| |\r\n| entity | Nullable | False | UserDefinedQuery->AddPermissionFilter eq TRUE |\r\n| entity | Nullable | True | UserDefinedQuery->AddPermissionFilter eq FALSE |\r\n| query | Nullable | False | |\r\n\r\n", "operationId": "UpdateUserDefinedQuery", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Query Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserDefinedQueryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Query was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "User Defined Query" ], "summary": "Delete an existing User Defined Query resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "DeleteUserDefinedQuery", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Query Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserDefinedQueryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Query 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/BI/UserDefinedQueries/{id}/Execute": { "get": { "tags": [ "User Defined Query" ], "summary": "Execute the custom User Defined Query to get the query results", "description": "", "operationId": "ExecuteUserDefinedQuery", "produces": [ "application/vnd.onkey.userdefinedquerypage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Defined Query definition", "schema": { "$ref": "#/definitions/UserDefinedQueryPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries": { "get": { "tags": [ "User Defined Query" ], "summary": "Get a collection of User Defined Query 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 | UserDefinedQuery->Id | integer | int64 |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n| code | UserDefinedQuery->Code | string | |\r\n| description | UserDefinedQuery->Description | string | |\r\n| sequenceNumber | UserDefinedQuery->SequenceNumber | integer | int32 |\r\n| notes | UserDefinedQuery->Notes | string | |\r\n| entity | UserDefinedQuery->Entity | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| isRunnable | UserDefinedQuery->IsRunnable | boolean | |\r\n| isActive | UserDefinedQuery->IsActive | boolean | |\r\n| permissionTreeCode | UserDefinedQuery->PermissionTree_Code | string | |\r\n| addPermissionFilter | UserDefinedQuery->AddPermissionFilter | boolean | |\r\n| createdOn | UserDefinedQuery->CreatedOn | string | date-time |\r\n| modifiedOn | UserDefinedQuery->ModifiedOn | string | date-time |\r\n", "operationId": "GetUserDefinedQueryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable User Defined Query collection", "schema": { "$ref": "#/definitions/GetUserDefinedQueryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Defined Query" ], "summary": "Create a new User Defined Query resource.", "description": "### Request Body\r\n#### 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 | UserDefinedQuery->Code | string | |\r\n| description | UserDefinedQuery->Description | string | |\r\n| permissionTreeId | UserDefinedQuery->PermissionTree_Id | integer | int64 |\r\n| entity | UserDefinedQuery->Entity | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| addPermissionFilter | UserDefinedQuery->AddPermissionFilter | boolean | |\r\n| query | UserDefinedQuery->Query | object | |\r\n| notes | UserDefinedQuery->Notes | string | |\r\n\r\n#### Business 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 | <= 500 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| entity | Nullable | False | UserDefinedQuery->AddPermissionFilter eq TRUE |\r\n| entity | Nullable | True | UserDefinedQuery->AddPermissionFilter eq FALSE |\r\n| query | Required | True | |\r\n| query | Nullable | False | |\r\n\r\n", "operationId": "CreateUserDefinedQuery", "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/CreateUserDefinedQueryResourceActionRequest" } }, { "$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/BI/UserDefinedQueries/Lookups/LookupUserDefinedQueryChangePermissionTree": { "get": { "tags": [ "User Defined Query" ], "summary": "Lookup the permission set for changing the User Defined Query.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupUserDefinedQueryChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/UserDefinedQueryChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries/Lookups/LookupUserDefinedQueryInsertPermissionTree": { "get": { "tags": [ "User Defined Query" ], "summary": "Lookup the permission set for creating the User Defined Query.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupUserDefinedQueryInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/UserDefinedQueryInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries/Batch": { "delete": { "tags": [ "User Defined Query" ], "summary": "Delete a collection of existing User Defined Query resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UserDefinedQuery->Id | integer | int64 |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchDeleteUserDefinedQuery", "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/BatchDeleteCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Defined Query 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/BI/UserDefinedQueries/{id}/Active": { "patch": { "tags": [ "User Defined Query" ], "summary": "Change the IsActive status for an existing User Defined Query resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n| isActive | UserDefinedQuery->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "ChangeUserDefinedQueryIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Query Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserDefinedQueryIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries/{id}/PermissionTree": { "patch": { "tags": [ "User Defined Query" ], "summary": "Change the PermissionTree for an existing User Defined Query resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n| permissionTreeId | UserDefinedQuery->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to 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": "ChangeUserDefinedQueryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Query Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserDefinedQueryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries/VerifyAll": { "post": { "tags": [ "User Defined Query" ], "summary": "Verify the SQL of all the User Defined Query resources", "description": "", "operationId": "VerifyAllUserDefinedQueries", "produces": [ "application/vnd.onkey.notification+json" ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries/{id}/Verify": { "post": { "tags": [ "User Defined Query" ], "summary": "Verify the SQL of the User Defined Query resource", "description": "", "operationId": "VerifyUserDefinedQuery", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Defined Query Id", "format": "int64", "x-nullable": false } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/BI/UserDefinedQueries/Batch/Active": { "patch": { "tags": [ "User Defined Query" ], "summary": "Change the IsActive status for a collection of existing User Defined Query resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UserDefinedQuery->Id | integer | int64 |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n| isActive | UserDefinedQuery->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchChangeUserDefinedQueryIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeUserDefinedQueryIsActiveResourceActionRequest" } }, { "$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/BI/UserDefinedQueries/Batch/PermissionTree": { "patch": { "tags": [ "User Defined Query" ], "summary": "Change the PermissionTree status for a collection of existing User Defined Query resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UserDefinedQuery->Id | integer | int64 |\r\n| version | UserDefinedQuery->Version | integer | int32 |\r\n| permissionTreeId | UserDefinedQuery->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\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": "BatchChangeUserDefinedQueryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeUserDefinedQueryPermissionTreeResourceActionRequest" } }, { "$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/BI/UserDefinedQueries/Batch/{ids}/Verify": { "post": { "tags": [ "User Defined Query" ], "summary": "Verify the SQL for the collection of User Defined Query resources", "description": "", "operationId": "BatchVerifyUserDefinedQuery", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of User Defined Query id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } } ], "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" ] }, "GetReportUrlResourceActionResponse": { "title": "GetReportUrlResourceActionResponse", "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": "GetReportUrlResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "url": { "title": "url", "type": "string", "x-nullable": true, "x-propertyPath": "InsightsPortalInfo->Url" } } }, "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" } } }, "GetInsightsUsersAvailableResourceActionResponse": { "title": "GetInsightsUsersAvailableResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "string", "x-nullable": true, "x-propertyPath": "InsightsUser->Id" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "InsightsUser->Name" }, "userDirectory": { "title": "userDirectory", "type": "string", "x-nullable": true, "x-propertyPath": "InsightsUser->UserDirectory" }, "userId": { "title": "userId", "type": "string", "x-nullable": true, "x-propertyPath": "InsightsUser->UserId" } } }, "GetInsightsUsersAvailableResourceAction": { "title": "GetInsightsUsersAvailableResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Insights entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Insights entities", "items": { "$ref": "#/definitions/GetInsightsUsersAvailableResourceActionResponse" } }, "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" } } }, "EntityType": { "type": "string", "description": "", "x-enumNames": [ "Alarm", "NewAlarm", "AlarmExpression", "AlarmExpressionTask", "AlarmAttribute", "AlarmDocument", "AlarmType", "MonitoringPoint", "MonitoringPointBoundEvaluationLog", "MonitoringPointParameter", "MonitoringPointReading", "MonitoringPointTrigger", "MonitoringPointTriggerExpression", "MonitoringPointTriggerExpressionAlarmType", "MonitoringPointTriggerExpressionParameter", "MonitoringPointTriggerExpressionEvaluation", "MonitoringPointTriggerExpressionEvaluationLog", "MonitoringPointType", "MonitoringPointTypeParameter", "MonitoringPointAttribute", "MonitoringPointDocument", "AuxiliaryAssetTask", "AuxiliaryAssetTaskResource", "AuxiliaryAssetTaskSpare", "AuxiliaryAssetTaskSubTask", "RegularAssetComponent", "RegularAssetComponentAttribute", "RegularAssetComponentDocument", "RegularAssetComponentRuleEvaluationFailure", "AssetComponent", "AssetWarranty", "PlaceholderAssetComponent", "PlaceholderAssetComponentOptionValue", "PlaceholderAssetComponentCondition", "PlaceholderAssetMeter", "PlaceholderAssetComponentRuleEvaluationFailure", "RegularAssetCondition", "RegularAssetActiveCondition", "AssetFmeca", "RegularAssetOptionValue", "Asset", "RegularAssetAttribute", "RegularAssetDocument", "RegularAssetFileAttachment", "PlaceholderAsset", "PlaceholderAssetAttribute", "PlaceholderAssetDocument", "PlaceholderAssetFileAttachment", "PlaceholderAssetRuleEvaluationFailure", "PlaceholderAssetResponsibility", "PlaceholderAssetCondition", "PlaceholderAssetActiveCondition", "AssetTask", "SetAssetTaskSpareWarehouseEntity", "RegularAssetTask", "RegularAssetTaskRuleEvaluationFailure", "RegularAssetTaskAttribute", "RegularAssetTaskAuxiliaryTask", "RegularAssetTaskFollowUpTask", "RegularAssetTaskFollowUpTaskExpression", "RegularAssetTaskSuppressedTask", "RegularAssetTaskResource", "RegularAssetTaskResourceRuleEvaluationFailure", "RegularAssetTaskSpare", "RegularAssetTaskSpareRuleEvaluationFailure", "RegularAssetTaskSubTask", "RegularAssetTaskFileAttachment", "AuxiliaryAssetTypeTask", "AuxiliaryAssetTypeTaskResource", "AuxiliaryAssetTypeTaskSpare", "AuxiliaryAssetTypeTaskSubTask", "RegularAssetTypeComponent", "RegularAssetTypeComponentAttribute", "RegularAssetTypeComponentDocument", "AssetTypeComponent", "PlaceholderAssetTypeComponent", "PlaceholderAssetTypeComponentCondition", "PlaceholderAssetTypeComponentAttribute", "PlaceholderAssetTypeComponentDocument", "PlaceholderAssetTypeComponentRuleLink", "RegularAssetTypeComponentRuleLink", "PlaceholderAssetComponentAttribute", "PlaceholderAssetComponentDocument", "PlaceholderAssetComponentActiveCondition", "AssetTypeFmeca", "AssetTypeFunction", "AssetFunction", "AssetFmecaTask", "AssetTypeFmecaTask", "AssetTypeFolder", "RegularAssetTypeOption", "AssetType", "PlaceholderAssetType", "PlaceholderAssetTypeSpare", "PlaceholderAssetTypeAttribute", "PlaceholderAssetTypeDocument", "PlaceholderAssetTypeResponsibility", "PlaceholderAssetTypeRuleLink", "RegularAssetTypeTask", "RegularAssetTypeTaskAttribute", "RegularAssetTypeTaskAuxiliaryTask", "RegularAssetTypeTaskCondition", "RegularAssetTypeTaskDocument", "RegularAssetTypeTaskFollowUpTask", "RegularAssetTypeTaskFollowUpTaskExpression", "AssetTypeTask", "AssetTypeTaskResource", "AssetTaskResource", "AssetTaskSpare", "AssetTypeTaskSpare", "RegularAssetTypeTaskResource", "RegularAssetTypeTaskRuleLink", "RegularAssetTypeTaskSpare", "RegularAssetTypeTaskSubTask", "RegularAssetTypeTaskSuppressedTask", "Condition", "ConditionType", "Event", "FailureCause", "FailureCauseType", "FailureMechanism", "FailureMechanismType", "FailureMode", "FailureModeType", "InPlaceAssetMeter", "InPlaceAssetAttribute", "InPlaceAssetFileAttachment", "InPlaceAssetRuleEvaluationFailure", "InPlaceAssetResponsibility", "InPlaceAssetSpare", "InPlaceAssetType", "InPlaceAssetTypeResponsibility", "InPlaceAssetTypeRuleLink", "InPlaceAssetTypeSpare", "InPlaceAsset", "Option", "OptionCategory", "RegularAsset", "RegularAssetTaskDocument", "RegularAssetMeter", "RegularAssetResponsibility", "RegularAssetMonitoringPointTrigger", "RegularAssetSpare", "RegularAssetTaskCondition", "RegularAssetType", "RegularAssetTypeAttribute", "RegularAssetTypeDocument", "RegularAssetTypeCondition", "PlaceholderAssetTypeCondition", "RegularAssetTypeRule", "RegularAssetTypeResponsibility", "RegularAssetTypeMonitoringPointTrigger", "RegularAssetTypeSpare", "RepairType", "Rule", "RuleCategory", "RuleOption", "StandardTask", "StandardTaskSpare", "StandardTaskSubTask", "StandardTaskResource", "StandardTaskAttribute", "StandardTaskDocument", "TaskImportance", "TaskInterval", "TaskIntervalType", "TaskRollUpPoint", "TypeOfWork", "RegularAssetTypeTaskSpareRuleLink", "InPlaceAssetTypeAttribute", "RegularAssetTypeTaskResourceRuleLink", "PlaceholderAssetSpare", "RegularAssetMonitoringPointTriggerParameter", "AssetSpare", "AssetTypeSpare", "AssetMeter", "AssetConsumption", "RegularAssetConsumption", "PlaceholderAssetConsumption", "InPlaceAssetConsumption", "WarrantyType", "RegularAssetTypeFileAttachment", "Meter", "MeterAttribute", "MeterDocument", "MeterReading", "PredictedMeterReading", "TimeLossCategory", "TimeLossReason", "TimeLossType", "Consumable", "AcquisitionStatus", "AcquisitionType", "DocumentFolder", "DocumentRecord", "DocumentRecordAttribute", "FileAttachment", "FileAttachmentCategory", "FileAttachmentContentHistory", "DocumentRecordFileHistory", "Costing", "CostingBudget", "CostCentre", "CostCentreAttribute", "CostCentreDocument", "CostCentreType", "CostElement", "CostElementAttribute", "CostElementDocument", "Currency", "BudgetTemplate", "BudgetTemplateParameter", "FinancialYear", "FinancialYearPeriod", "GeneralLedger", "GeneralLedgerAttribute", "GeneralLedgerDocument", "CurrencyRate", "Budget", "BudgetParameter", "AddressType", "Approval", "Attribute", "AttributeAllowedValue", "Calendar", "CalendarDay", "CalendarException", "CalendarDayHour", "Classification", "ClassificationAllowedValue", "EmailType", "Language", "OperationalRole", "OperationalRoleTemplate", "OperationalRoleResource", "PhoneNumberType", "UserOperationalRole", "UserOperationalRoleTemplate", "UserOperationalRoleResource", "TermsAndCondition", "TermsAndConditionVersion", "TermsAndConditionOperationalRole", "UserTermsAndConditionVersion", "Location", "LocationAttribute", "LocationDocument", "LocalisationSet", "LocalisationKey", "LocalisationTranslation", "Phrase", "PhraseTranslation", "PreconfiguredReason", "Site", "SiteAttribute", "SiteDocument", "SiteType", "Supplier", "SupplierFileAttachment", "SupplierAttribute", "SupplierDocument", "SupplierContactAddress", "SupplierContactEmail", "SupplierContactPhoneNumber", "SupplierResource", "SupplierTaxRate", "UnitOfMeasurement", "SiteResource", "SiteContactAddress", "SiteContactEmail", "SiteContactPhoneNumber", "ChangeDataTrigger", "ChangeDataTriggerOccurrenceLog", "ChangeDataTriggerCriteria", "NotificationTemplate", "ChangeDataTriggerCriteriaParameter", "ChangeDataTriggerNotificationEvent", "NotificationTemplateParameter", "ChangeDataTriggerNotificationEventAttachment", "ChangeDataTriggerNotificationEventAttachmentParameter", "RequestType", "Category", "Commodity", "MaterialMaster", "MaterialMasterAttribute", "MaterialMasterDocument", "MaterialMasterBin", "MaterialMasterSupplier", "MaterialMasterLinkWarehouse", "StockItem", "StockItemFileAttachment", "StockItemAttribute", "StockItemDocument", "StockItemBin", "StockItemSupplier", "WarehouseAttribute", "Warehouse", "WarehouseDocument", "Requisition", "RequisitionFileAttachment", "RequisitionStatus", "RequisitionStatusChange", "RequisitionStatusAttribute", "RequisitionStatusDocument", "RequisitionStatusChangeHistory", "RequisitionItemTransaction", "ApprovalRole", "RequisitionAttribute", "RequisitionDocument", "RequisitionTransaction", "RequisitionItem", "RequisitionItemFileAttachment", "UserSiteApprovalRole", "ApprovalWorkflow", "ApprovalWorkflowExpression", "ApprovalWorkflowExpressionApprovalRole", "Competency", "Resource", "ResourceAttribute", "ResourceAddress", "ResourceClassification", "ResourceCompetency", "ResourceDocument", "ResourceEmail", "ResourcePhoneNumber", "ResourceTrade", "ResourceTradeCompetency", "ResourceTradeFinancialRate", "Section", "SectionAttribute", "SectionDocument", "SectionTrade", "TradeAttribute", "TradeDocument", "Trade", "TradeCompetency", "TradeFinancialRate", "ResourceContext", "ResourceFileAttachment", "AssetImportance", "RiskConsequence", "RiskConsequenceCategory", "RiskModel", "RiskModelConsequenceCategory", "RiskModelImportance", "RiskModelProbability", "RiskProbability", "WorkOrderImportance", "WorkOrderStatus", "WorkOrderStatusAttribute", "WorkOrderStatusDocument", "WorkOrderStatusAllowedChange", "WorkOrder", "WorkOrderStatusChangeHistory", "WorkOrderStatusChange", "WorkOrderMerge", "WorkOrderSplit", "WorkOrderMeter", "WorkOrderAttribute", "WorkOrderDocument", "WorkOrderFileAttachment", "WorkOrderTaskFileAttachment", "WorkOrderTaskWarranty", "WorkOrderTaskSpareFileAttachment", "WorkOrderTask", "WorkOrderTaskDocument", "WorkOrderTaskAdHocCost", "WorkOrderMonitoringPoint", "WorkOrderTaskMonitoringPoint", "WorkOrderTaskSpare", "WorkOrderTaskSubTask", "WorkOrderTaskResource", "WorkOrderTaskResourceUsage", "DueTask", "DueTaskSuppressor", "ProposedWorkOrderBatch", "ProposedWorkOrder", "ProposedWorkOrderTask", "ProposedWorkOrderMeter", "WorkOrderMovement", "WorkOrderTaskMovement", "WorkOrderTaskResourceMovement", "WorkOrderTaskSpareMovement", "WorkOrderTaskSubTaskMovement", "WorkOrderCompleteAllTasksLog", "WorkRequest", "WorkRequestAttribute", "WorkRequestDocument", "WorkRequestStatus", "WorkRequestStatusChange", "WorkRequestStatusChangeHistory", "WorkRequestFileAttachment", "WorkOrderDowntimeLoss", "WorkOrderProgressEvent", "WorkOrderProgressEventAllowedChange", "WorkOrderProgressLog", "WorkOrderWarranty", "ServiceLevelAgreementClassification", "ServiceLevelAgreement", "ServiceLevelAgreementMeasure", "WorkOrderServiceLevelAgreement", "WorkOrderServiceLevelAgreementMeasure", "ServiceLevelAgreementMeasureTrigger", "ServiceLevelAgreementMeasureFieldAssignment", "PermissionTree", "User", "UserAttribute", "UserDocument", "UserAuthentication", "SecurityRole", "SecurityRolePermission", "UserSecurityRole", "UserCustomPermission", "UserOption", "BackgroundTask", "BackgroundTaskStep", "ScheduledBackgroundTask", "ScheduledJob", "UserDefinedField", "UserDefinedFieldPredefinedValue", "SystemOption", "SystemOptionPageLimit", "SystemOptionWorkOrderStatus", "SystemOptionDefaultStandardTask", "SystemOptionWorkOrderStatusTypeOfWork", "SystemOptionReferenceDataViewPermission", "SystemOptionFileAttachmentCategory", "SystemOptionFileAttachmentFileType", "RecordChange", "RecordChangeValue", "RecordChangeUser", "RecordChangeProperty", "NotificationEventOutbox", "NotificationEventAttachmentOutbox", "NotificationOutbox", "NotificationOutboxLog", "ChangeDataTriggerCriteriaEvaluation", "SystemOptionReportServerEntity", "SystemOptionReportServerEntityDefaultReport", "TemplateMigrationLog", "TemplateMigrationLogIntent", "ResourceActionMigrationLog", "ImportSchema", "ImportFile", "UserDefinedQuery", "ResourceActionCustomisation", "TemplateCustomisation", "TemplateResource", "ClusterSettings", "ClusterIdentityProviderSettings", "MessageBrokerHost", "MessageBrokerTopic", "MessageBrokerTopicConsumer", "TenantSettings", "TenantChangeDataSubscriptionSettings", "TenantIdentityProviderSettings", "TenantJobSettings", "TenantFileContentStoreLocationSettings", "TenantFileContentStoreFileTypeGroupSettings", "TenantFileContentStoreFileTypeSettings", "ClusterFeatureToggle", "TenantFeatureToggle", "TenantHealthCheck", "TenantMachineHealthCheck", "ClusterHealthCheck", "ClusterMachineHealthCheck", "ClusterCapacitySlot", "TenantChangeLogCleanupExpressionSettings", "ClusterJobSettings", "Ignore" ], "enum": [ "Alarm", "NewAlarm", "AlarmExpression", "AlarmExpressionTask", "AlarmAttribute", "AlarmDocument", "AlarmType", "MonitoringPoint", "MonitoringPointBoundEvaluationLog", "MonitoringPointParameter", "MonitoringPointReading", "MonitoringPointTrigger", "MonitoringPointTriggerExpression", "MonitoringPointTriggerExpressionAlarmType", "MonitoringPointTriggerExpressionParameter", "MonitoringPointTriggerExpressionEvaluation", "MonitoringPointTriggerExpressionEvaluationLog", "MonitoringPointType", "MonitoringPointTypeParameter", "MonitoringPointAttribute", "MonitoringPointDocument", "AuxiliaryAssetTask", "AuxiliaryAssetTaskResource", "AuxiliaryAssetTaskSpare", "AuxiliaryAssetTaskSubTask", "RegularAssetComponent", "RegularAssetComponentAttribute", "RegularAssetComponentDocument", "RegularAssetComponentRuleEvaluationFailure", "AssetComponent", "AssetWarranty", "PlaceholderAssetComponent", "PlaceholderAssetComponentOptionValue", "PlaceholderAssetComponentCondition", "PlaceholderAssetMeter", "PlaceholderAssetComponentRuleEvaluationFailure", "RegularAssetCondition", "RegularAssetActiveCondition", "AssetFmeca", "RegularAssetOptionValue", "Asset", "RegularAssetAttribute", "RegularAssetDocument", "RegularAssetFileAttachment", "PlaceholderAsset", "PlaceholderAssetAttribute", "PlaceholderAssetDocument", "PlaceholderAssetFileAttachment", "PlaceholderAssetRuleEvaluationFailure", "PlaceholderAssetResponsibility", "PlaceholderAssetCondition", "PlaceholderAssetActiveCondition", "AssetTask", "SetAssetTaskSpareWarehouseEntity", "RegularAssetTask", "RegularAssetTaskRuleEvaluationFailure", "RegularAssetTaskAttribute", "RegularAssetTaskAuxiliaryTask", "RegularAssetTaskFollowUpTask", "RegularAssetTaskFollowUpTaskExpression", "RegularAssetTaskSuppressedTask", "RegularAssetTaskResource", "RegularAssetTaskResourceRuleEvaluationFailure", "RegularAssetTaskSpare", "RegularAssetTaskSpareRuleEvaluationFailure", "RegularAssetTaskSubTask", "RegularAssetTaskFileAttachment", "AuxiliaryAssetTypeTask", "AuxiliaryAssetTypeTaskResource", "AuxiliaryAssetTypeTaskSpare", "AuxiliaryAssetTypeTaskSubTask", "RegularAssetTypeComponent", "RegularAssetTypeComponentAttribute", "RegularAssetTypeComponentDocument", "AssetTypeComponent", "PlaceholderAssetTypeComponent", "PlaceholderAssetTypeComponentCondition", "PlaceholderAssetTypeComponentAttribute", "PlaceholderAssetTypeComponentDocument", "PlaceholderAssetTypeComponentRuleLink", "RegularAssetTypeComponentRuleLink", "PlaceholderAssetComponentAttribute", "PlaceholderAssetComponentDocument", "PlaceholderAssetComponentActiveCondition", "AssetTypeFmeca", "AssetTypeFunction", "AssetFunction", "AssetFmecaTask", "AssetTypeFmecaTask", "AssetTypeFolder", "RegularAssetTypeOption", "AssetType", "PlaceholderAssetType", "PlaceholderAssetTypeSpare", "PlaceholderAssetTypeAttribute", "PlaceholderAssetTypeDocument", "PlaceholderAssetTypeResponsibility", "PlaceholderAssetTypeRuleLink", "RegularAssetTypeTask", "RegularAssetTypeTaskAttribute", "RegularAssetTypeTaskAuxiliaryTask", "RegularAssetTypeTaskCondition", "RegularAssetTypeTaskDocument", "RegularAssetTypeTaskFollowUpTask", "RegularAssetTypeTaskFollowUpTaskExpression", "AssetTypeTask", "AssetTypeTaskResource", "AssetTaskResource", "AssetTaskSpare", "AssetTypeTaskSpare", "RegularAssetTypeTaskResource", "RegularAssetTypeTaskRuleLink", "RegularAssetTypeTaskSpare", "RegularAssetTypeTaskSubTask", "RegularAssetTypeTaskSuppressedTask", "Condition", "ConditionType", "Event", "FailureCause", "FailureCauseType", "FailureMechanism", "FailureMechanismType", "FailureMode", "FailureModeType", "InPlaceAssetMeter", "InPlaceAssetAttribute", "InPlaceAssetFileAttachment", "InPlaceAssetRuleEvaluationFailure", "InPlaceAssetResponsibility", "InPlaceAssetSpare", "InPlaceAssetType", "InPlaceAssetTypeResponsibility", "InPlaceAssetTypeRuleLink", "InPlaceAssetTypeSpare", "InPlaceAsset", "Option", "OptionCategory", "RegularAsset", "RegularAssetTaskDocument", "RegularAssetMeter", "RegularAssetResponsibility", "RegularAssetMonitoringPointTrigger", "RegularAssetSpare", "RegularAssetTaskCondition", "RegularAssetType", "RegularAssetTypeAttribute", "RegularAssetTypeDocument", "RegularAssetTypeCondition", "PlaceholderAssetTypeCondition", "RegularAssetTypeRule", "RegularAssetTypeResponsibility", "RegularAssetTypeMonitoringPointTrigger", "RegularAssetTypeSpare", "RepairType", "Rule", "RuleCategory", "RuleOption", "StandardTask", "StandardTaskSpare", "StandardTaskSubTask", "StandardTaskResource", "StandardTaskAttribute", "StandardTaskDocument", "TaskImportance", "TaskInterval", "TaskIntervalType", "TaskRollUpPoint", "TypeOfWork", "RegularAssetTypeTaskSpareRuleLink", "InPlaceAssetTypeAttribute", "RegularAssetTypeTaskResourceRuleLink", "PlaceholderAssetSpare", "RegularAssetMonitoringPointTriggerParameter", "AssetSpare", "AssetTypeSpare", "AssetMeter", "AssetConsumption", "RegularAssetConsumption", "PlaceholderAssetConsumption", "InPlaceAssetConsumption", "WarrantyType", "RegularAssetTypeFileAttachment", "Meter", "MeterAttribute", "MeterDocument", "MeterReading", "PredictedMeterReading", "TimeLossCategory", "TimeLossReason", "TimeLossType", "Consumable", "AcquisitionStatus", "AcquisitionType", "DocumentFolder", "DocumentRecord", "DocumentRecordAttribute", "FileAttachment", "FileAttachmentCategory", "FileAttachmentContentHistory", "DocumentRecordFileHistory", "Costing", "CostingBudget", "CostCentre", "CostCentreAttribute", "CostCentreDocument", "CostCentreType", "CostElement", "CostElementAttribute", "CostElementDocument", "Currency", "BudgetTemplate", "BudgetTemplateParameter", "FinancialYear", "FinancialYearPeriod", "GeneralLedger", "GeneralLedgerAttribute", "GeneralLedgerDocument", "CurrencyRate", "Budget", "BudgetParameter", "AddressType", "Approval", "Attribute", "AttributeAllowedValue", "Calendar", "CalendarDay", "CalendarException", "CalendarDayHour", "Classification", "ClassificationAllowedValue", "EmailType", "Language", "OperationalRole", "OperationalRoleTemplate", "OperationalRoleResource", "PhoneNumberType", "UserOperationalRole", "UserOperationalRoleTemplate", "UserOperationalRoleResource", "TermsAndCondition", "TermsAndConditionVersion", "TermsAndConditionOperationalRole", "UserTermsAndConditionVersion", "Location", "LocationAttribute", "LocationDocument", "LocalisationSet", "LocalisationKey", "LocalisationTranslation", "Phrase", "PhraseTranslation", "PreconfiguredReason", "Site", "SiteAttribute", "SiteDocument", "SiteType", "Supplier", "SupplierFileAttachment", "SupplierAttribute", "SupplierDocument", "SupplierContactAddress", "SupplierContactEmail", "SupplierContactPhoneNumber", "SupplierResource", "SupplierTaxRate", "UnitOfMeasurement", "SiteResource", "SiteContactAddress", "SiteContactEmail", "SiteContactPhoneNumber", "ChangeDataTrigger", "ChangeDataTriggerOccurrenceLog", "ChangeDataTriggerCriteria", "NotificationTemplate", "ChangeDataTriggerCriteriaParameter", "ChangeDataTriggerNotificationEvent", "NotificationTemplateParameter", "ChangeDataTriggerNotificationEventAttachment", "ChangeDataTriggerNotificationEventAttachmentParameter", "RequestType", "Category", "Commodity", "MaterialMaster", "MaterialMasterAttribute", "MaterialMasterDocument", "MaterialMasterBin", "MaterialMasterSupplier", "MaterialMasterLinkWarehouse", "StockItem", "StockItemFileAttachment", "StockItemAttribute", "StockItemDocument", "StockItemBin", "StockItemSupplier", "WarehouseAttribute", "Warehouse", "WarehouseDocument", "Requisition", "RequisitionFileAttachment", "RequisitionStatus", "RequisitionStatusChange", "RequisitionStatusAttribute", "RequisitionStatusDocument", "RequisitionStatusChangeHistory", "RequisitionItemTransaction", "ApprovalRole", "RequisitionAttribute", "RequisitionDocument", "RequisitionTransaction", "RequisitionItem", "RequisitionItemFileAttachment", "UserSiteApprovalRole", "ApprovalWorkflow", "ApprovalWorkflowExpression", "ApprovalWorkflowExpressionApprovalRole", "Competency", "Resource", "ResourceAttribute", "ResourceAddress", "ResourceClassification", "ResourceCompetency", "ResourceDocument", "ResourceEmail", "ResourcePhoneNumber", "ResourceTrade", "ResourceTradeCompetency", "ResourceTradeFinancialRate", "Section", "SectionAttribute", "SectionDocument", "SectionTrade", "TradeAttribute", "TradeDocument", "Trade", "TradeCompetency", "TradeFinancialRate", "ResourceContext", "ResourceFileAttachment", "AssetImportance", "RiskConsequence", "RiskConsequenceCategory", "RiskModel", "RiskModelConsequenceCategory", "RiskModelImportance", "RiskModelProbability", "RiskProbability", "WorkOrderImportance", "WorkOrderStatus", "WorkOrderStatusAttribute", "WorkOrderStatusDocument", "WorkOrderStatusAllowedChange", "WorkOrder", "WorkOrderStatusChangeHistory", "WorkOrderStatusChange", "WorkOrderMerge", "WorkOrderSplit", "WorkOrderMeter", "WorkOrderAttribute", "WorkOrderDocument", "WorkOrderFileAttachment", "WorkOrderTaskFileAttachment", "WorkOrderTaskWarranty", "WorkOrderTaskSpareFileAttachment", "WorkOrderTask", "WorkOrderTaskDocument", "WorkOrderTaskAdHocCost", "WorkOrderMonitoringPoint", "WorkOrderTaskMonitoringPoint", "WorkOrderTaskSpare", "WorkOrderTaskSubTask", "WorkOrderTaskResource", "WorkOrderTaskResourceUsage", "DueTask", "DueTaskSuppressor", "ProposedWorkOrderBatch", "ProposedWorkOrder", "ProposedWorkOrderTask", "ProposedWorkOrderMeter", "WorkOrderMovement", "WorkOrderTaskMovement", "WorkOrderTaskResourceMovement", "WorkOrderTaskSpareMovement", "WorkOrderTaskSubTaskMovement", "WorkOrderCompleteAllTasksLog", "WorkRequest", "WorkRequestAttribute", "WorkRequestDocument", "WorkRequestStatus", "WorkRequestStatusChange", "WorkRequestStatusChangeHistory", "WorkRequestFileAttachment", "WorkOrderDowntimeLoss", "WorkOrderProgressEvent", "WorkOrderProgressEventAllowedChange", "WorkOrderProgressLog", "WorkOrderWarranty", "ServiceLevelAgreementClassification", "ServiceLevelAgreement", "ServiceLevelAgreementMeasure", "WorkOrderServiceLevelAgreement", "WorkOrderServiceLevelAgreementMeasure", "ServiceLevelAgreementMeasureTrigger", "ServiceLevelAgreementMeasureFieldAssignment", "PermissionTree", "User", "UserAttribute", "UserDocument", "UserAuthentication", "SecurityRole", "SecurityRolePermission", "UserSecurityRole", "UserCustomPermission", "UserOption", "BackgroundTask", "BackgroundTaskStep", "ScheduledBackgroundTask", "ScheduledJob", "UserDefinedField", "UserDefinedFieldPredefinedValue", "SystemOption", "SystemOptionPageLimit", "SystemOptionWorkOrderStatus", "SystemOptionDefaultStandardTask", "SystemOptionWorkOrderStatusTypeOfWork", "SystemOptionReferenceDataViewPermission", "SystemOptionFileAttachmentCategory", "SystemOptionFileAttachmentFileType", "RecordChange", "RecordChangeValue", "RecordChangeUser", "RecordChangeProperty", "NotificationEventOutbox", "NotificationEventAttachmentOutbox", "NotificationOutbox", "NotificationOutboxLog", "ChangeDataTriggerCriteriaEvaluation", "SystemOptionReportServerEntity", "SystemOptionReportServerEntityDefaultReport", "TemplateMigrationLog", "TemplateMigrationLogIntent", "ResourceActionMigrationLog", "ImportSchema", "ImportFile", "UserDefinedQuery", "ResourceActionCustomisation", "TemplateCustomisation", "TemplateResource", "ClusterSettings", "ClusterIdentityProviderSettings", "MessageBrokerHost", "MessageBrokerTopic", "MessageBrokerTopicConsumer", "TenantSettings", "TenantChangeDataSubscriptionSettings", "TenantIdentityProviderSettings", "TenantJobSettings", "TenantFileContentStoreLocationSettings", "TenantFileContentStoreFileTypeGroupSettings", "TenantFileContentStoreFileTypeSettings", "ClusterFeatureToggle", "TenantFeatureToggle", "TenantHealthCheck", "TenantMachineHealthCheck", "ClusterHealthCheck", "ClusterMachineHealthCheck", "ClusterCapacitySlot", "TenantChangeLogCleanupExpressionSettings", "ClusterJobSettings", "Ignore" ] }, "GetReportServerIntegrationTokenResourceActionResponse": { "title": "GetReportServerIntegrationTokenResourceActionResponse", "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": "GetReportServerIntegrationTokenResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "accessToken": { "title": "accessToken", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerIntegrationToken->AccessToken" }, "expiresIn": { "title": "expiresIn", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerIntegrationToken->ExpiresIn" }, "integrationUrl": { "title": "integrationUrl", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerIntegrationToken->IntegrationUrl" }, "tokenType": { "title": "tokenType", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerIntegrationToken->TokenType" } } }, "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" } } }, "GetReportUrlResourceActionResponse2": { "title": "GetReportUrlResourceActionResponse", "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": "GetReportUrlResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "url": { "title": "url", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerUrl->Url" }, "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ReportServerUrl->Type", "x-formatSpecifier": "ReportServerUrlType" } } }, "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" } } }, "GetViewReportUrlResourceActionResponse": { "title": "GetViewReportUrlResourceActionResponse", "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": "GetViewReportUrlResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "url": { "title": "url", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerUrl->Url" }, "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ReportServerUrl->Type", "x-formatSpecifier": "ReportServerUrlType" } } }, "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" } } }, "GetReportServerDashboardsResourceActionResponse": { "title": "GetReportServerDashboardsResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerDashboard->Id" }, "title": { "title": "title", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerDashboard->Title" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerDashboard->Description" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerDashboard->Category" } } }, "GetReportServerDashboardsResourceAction": { "title": "GetReportServerDashboardsResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Report entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Report entities", "items": { "$ref": "#/definitions/GetReportServerDashboardsResourceActionResponse" } }, "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" } } }, "GetReportServerReportLanguageResourceActionResponse": { "title": "GetReportServerReportLanguageResourceActionResponse", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReportLanguage->Name" }, "displayName": { "title": "displayName", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReportLanguage->DisplayName" } } }, "GetReportServerReportLanguageResourceAction": { "title": "GetReportServerReportLanguageResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Report entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Report entities", "items": { "$ref": "#/definitions/GetReportServerReportLanguageResourceActionResponse" } }, "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" } } }, "GetReportServerReportsResourceActionResponse": { "title": "GetReportServerReportsResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReport->Id" }, "title": { "title": "title", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReport->Title" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReport->Description" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReport->Category" } } }, "GetReportServerReportsResourceAction": { "title": "GetReportServerReportsResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Report entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Report entities", "items": { "$ref": "#/definitions/GetReportServerReportsResourceActionResponse" } }, "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" } } }, "GetReportServerRolesResourceActionResponse": { "title": "GetReportServerRolesResourceActionResponse", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerRole->Name" } } }, "GetReportServerRolesResourceAction": { "title": "GetReportServerRolesResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Report entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Report entities", "items": { "$ref": "#/definitions/GetReportServerRolesResourceActionResponse" } }, "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" } } }, "GetReportServerTagsResourceActionResponse": { "title": "GetReportServerTagsResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerTag->Id" }, "parentId": { "title": "parentId", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerTag->ParentId" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerTag->Name" }, "color": { "title": "color", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerTag->Color" }, "documentCount": { "title": "documentCount", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ReportServerTag->DocumentCount" }, "isFavorites": { "title": "isFavorites", "type": "boolean", "x-nullable": true, "x-propertyPath": "ReportServerTag->IsFavorites" }, "order": { "title": "order", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ReportServerTag->Order" } } }, "GetReportServerTagsResourceAction": { "title": "GetReportServerTagsResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Report entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Report entities", "items": { "$ref": "#/definitions/GetReportServerTagsResourceActionResponse" } }, "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" } } }, "GetReportServerUserInterfaceLanguageResourceActionResponse": { "title": "GetReportServerUserInterfaceLanguageResourceActionResponse", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReportLanguage->Name" }, "displayName": { "title": "displayName", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReportLanguage->DisplayName" } } }, "GetReportServerUserInterfaceLanguageResourceAction": { "title": "GetReportServerUserInterfaceLanguageResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Report entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Report entities", "items": { "$ref": "#/definitions/GetReportServerUserInterfaceLanguageResourceActionResponse" } }, "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" } } }, "UserDefinedQuerySqlSchema": { "type": "object", "required": [ "sql" ], "properties": { "sql": { "type": "string" }, "columns": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedQueryColumnSchema" } }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedQueryParameterSchema" } } } }, "UserDefinedQueryColumnSchema": { "type": "object", "required": [ "propertyName", "columnName", "output", "primaryPermissionColumn", "permissionColumn" ], "properties": { "propertyName": { "type": "string" }, "columnName": { "type": "string" }, "propertyPath": { "type": "string" }, "output": { "type": "boolean" }, "primaryPermissionColumn": { "type": "boolean" }, "permissionColumn": { "type": "boolean" }, "permissionForColumns": { "type": "array", "items": { "type": "string" } } } }, "UserDefinedQueryParameterSchema": { "type": "object", "required": [ "parameterName", "injectCurrentUser", "primaryPermissionParameter" ], "properties": { "parameterName": { "type": "string" }, "injectCurrentUser": { "type": "boolean" }, "primaryPermissionParameter": { "type": "boolean" } } }, "GetUserDefinedQueryResourceActionResponse": { "title": "GetUserDefinedQueryResourceActionResponse", "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": "GetUserDefinedQueryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedQuery->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedQuery->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->PermissionTree_Description" }, "addPermissionFilter": { "title": "addPermissionFilter", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->AddPermissionFilter" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Description" }, "entity": { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Entity", "x-formatSpecifier": "EntityType", "x-NullExpression": "UserDefinedQuery->AddPermissionFilter eq TRUE" }, "isRunnable": { "title": "isRunnable", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->IsRunnable" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->Notes" }, "query": { "title": "query", "x-nullable": false, "$ref": "#/definitions/UserDefinedQuerySqlSchema", "x-propertyPath": "UserDefinedQuery->Query" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->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" } } }, "UserDefinedQueryPageSchema": { "allOf": [ { "$ref": "#/definitions/EntityCollectionPageSchema" }, { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/definitions/UserDefinedQueryColumnSchema" } } } } ] }, "EntityCollectionPageSchema": { "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" }, "preparedQueryBatchId": { "type": "integer", "description": "Link to next page of resource data", "format": "int64" }, "preparedQueryBatchSize": { "type": "integer", "description": "Link to next page of resource data", "format": "int32" }, "items": { "type": "array", "description": "List of resource items", "items": { "$ref": "#/definitions/EntitySchema" } }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "type": "array", "description": "List of messages for Resource data", "items": { "$ref": "#/definitions/NotificationItemSchema" } }, "permissionViolationsLookup": { "description": "Lookup to find more information about the permission violations", "$ref": "#/definitions/PermissionViolationLookupSchema" }, "links": { "type": "array", "description": "Hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "EntitySchema": { "type": "object", "required": [ "class", "properties", "links" ], "properties": { "class": { "type": "string", "description": "Type of resource" }, "id": { "type": "integer", "description": "Id of Resource", "format": "int64" }, "version": { "type": "integer", "description": "Version of Resource", "format": "int32" }, "properties": { "type": "object", "description": "List of properties as a map `{ \"name\" : value, ...}`", "additionalProperties": {} }, "messages": { "type": "array", "description": "List of messages for Resource data", "items": { "$ref": "#/definitions/NotificationItemSchema" } }, "permissionViolations": { "type": "array", "description": "List of permission violations for resource data", "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "permissionViolationsLookup": { "description": "Lookup to find more information about the permission violations", "$ref": "#/definitions/PermissionViolationLookupSchema" }, "translations": { "type": "array", "description": "Translations for resource data", "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "links": { "type": "array", "description": "Hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "description": "Self link to re-execute", "$ref": "#/definitions/Link" } } }, "PermissionViolationLookupSchema": { "type": "object", "properties": { "permissions": { "type": "array", "description": "Lookup table to find more information about the permissions for the violations", "items": { "$ref": "#/definitions/PermissionViolationPermissionLookupSchema" } }, "permissionTrees": { "type": "array", "description": "Lookup table to find more information about the permission trees for the violations", "items": { "$ref": "#/definitions/PermissionViolationTreeCodeLookupSchema" } } } }, "PermissionViolationPermissionLookupSchema": { "type": "object", "required": [ "permissionId", "permissionCategory", "permissionSubcategory", "permissionEntityName", "permissionName" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionCategory": { "type": "string" }, "permissionSubcategory": { "type": "string" }, "permissionEntityName": { "type": "string" }, "permissionName": { "type": "string" } } }, "PermissionViolationTreeCodeLookupSchema": { "type": "object", "required": [ "permissionTreeId", "permissionTreeCode" ], "properties": { "permissionTreeId": { "type": "integer", "format": "int64" }, "permissionTreeCode": { "type": "string" } } }, "GetUserDefinedQueryCollectionResourceActionResponse": { "title": "GetUserDefinedQueryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetUserDefinedQueryCollectionResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "GetUserDefinedQueryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->Notes" }, "entity": { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Entity", "x-formatSpecifier": "EntityType", "x-NullExpression": "UserDefinedQuery->AddPermissionFilter eq TRUE" }, "isRunnable": { "title": "isRunnable", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->IsRunnable" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->IsActive" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->PermissionTree_Code" }, "addPermissionFilter": { "title": "addPermissionFilter", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->AddPermissionFilter" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedQuery->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDefinedQuery->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" } } } }, "UserDefinedQueryChangePermissionTreeLookupResourceActionResponse": { "title": "UserDefinedQueryChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedQueryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedQueryChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "UserDefinedQueryInsertPermissionTreeLookupResourceActionResponse": { "title": "UserDefinedQueryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "UserDefinedQueryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "x-nullable": true, "example": 2 }, "properties": { "title": "UserDefinedQueryInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateUserDefinedQueryResourceActionRequest": { "title": "CreateUserDefinedQueryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserDefinedQueryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId", "query" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Code" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->PermissionTree_Id" }, "entity": { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Entity", "x-formatSpecifier": "EntityType", "x-NullExpression": "UserDefinedQuery->AddPermissionFilter eq TRUE" }, "addPermissionFilter": { "title": "addPermissionFilter", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->AddPermissionFilter" }, "query": { "title": "query", "x-nullable": false, "$ref": "#/definitions/UserDefinedQuerySqlSchema", "x-propertyPath": "UserDefinedQuery->Query" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->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" } } }, "UpdateUserDefinedQueryResourceActionRequest": { "title": "UpdateUserDefinedQueryResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "UserDefinedQuery->Code" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Description" }, { "title": "entity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Entity", "x-formatSpecifier": "EntityType", "x-NullExpression": "UserDefinedQuery->AddPermissionFilter eq TRUE" }, { "title": "addPermissionFilter", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->AddPermissionFilter" }, { "title": "query", "x-nullable": false, "x-propertyPath": "UserDefinedQuery->Query" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDefinedQuery->Notes" } ] } } }, "DeleteUserDefinedQueryResourceActionRequest": { "title": "DeleteUserDefinedQueryResourceActionRequest", "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 } } }, "BatchDeleteCategoryResourceActionRequest": { "title": "BatchDeleteCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserDefinedQueryResourceActionRequest" } }, "ChangeUserDefinedQueryIsActiveResourceActionRequest": { "title": "ChangeUserDefinedQueryIsActiveResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "UserDefinedQuery->IsActive" } ] } } }, "ChangeUserDefinedQueryPermissionTreeResourceActionRequest": { "title": "ChangeUserDefinedQueryPermissionTreeResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "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": "UserDefinedQuery->PermissionTree_Id" } ] } } }, "BatchChangeUserDefinedQueryIsActiveResourceActionRequest": { "title": "BatchChangeUserDefinedQueryIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserDefinedQueryIsActiveResourceActionRequest" } }, "BatchChangeUserDefinedQueryPermissionTreeResourceActionRequest": { "title": "BatchChangeUserDefinedQueryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserDefinedQueryPermissionTreeResourceActionRequest" } } }, "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": "Insights" }, { "name": "Report" }, { "name": "User Defined Query" } ], "x-tagGroups": [ { "name": "BI", "tags": [ "Insights", "Report", "User Defined Query" ] } ] }