{"openapi":"3.0.4","info":{"title":"Create a Check Definition","description":"Creates a Check Definition. Returns the created Check Definition at the current effectiveAt.\r\nNote that Check Definitions are mono-temporal, however they can have Time-Variant Properties.\r\nUpserted Properties will be returned at the latest AsAt and EffectiveAt","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/dataquality/checkdefinitions":{"post":{"tags":["CheckDefinitions"],"summary":"Create a Check Definition","description":"Creates a Check Definition. Returns the created Check Definition at the current effectiveAt.\r\nNote that Check Definitions are mono-temporal, however they can have Time-Variant Properties.\r\nUpserted Properties will be returned at the latest AsAt and EffectiveAt","operationId":"CreateCheckDefinition","requestBody":{"description":"The request containing the details of the Check Definition","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateCheckDefinitionRequest"},"example":{"id":{"scope":"DataQuality","code":"PortfolioBalanceCheck"},"displayName":"Portfolio Balance Validation","description":"A check definition to validate portfolio balances are within expected ranges","datasetSchema":{"type":"LusidEntity","entityType":"Portfolios"},"ruleSets":[{"ruleSetKey":"PositiveBalanceRule","displayName":"BalanceRuleSet","description":"Rules for validating portfolio balance data","ruleSetFilter":"Portfolio.Properties[Portfolio/DataQuality/Type] eq 'Equity'"}],"properties":{"CheckDefinition/DataQuality/Priority":{"key":"CheckDefinition/DataQuality/Priority","value":{"labelValue":"High"},"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","effectiveUntil":"2025-12-31T23:59:59.0000000+00:00"}}}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateCheckDefinitionRequest"},"example":{"id":{"scope":"DataQuality","code":"PortfolioBalanceCheck"},"displayName":"Portfolio Balance Validation","description":"A check definition to validate portfolio balances are within expected ranges","datasetSchema":{"type":"LusidEntity","entityType":"Portfolios"},"ruleSets":[{"ruleSetKey":"PositiveBalanceRule","displayName":"BalanceRuleSet","description":"Rules for validating portfolio balance data","ruleSetFilter":"Portfolio.Properties[Portfolio/DataQuality/Type] eq 'Equity'"}],"properties":{"CheckDefinition/DataQuality/Priority":{"key":"CheckDefinition/DataQuality/Priority","value":{"labelValue":"High"},"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","effectiveUntil":"2025-12-31T23:59:59.0000000+00:00"}}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateCheckDefinitionRequest"},"example":{"id":{"scope":"DataQuality","code":"PortfolioBalanceCheck"},"displayName":"Portfolio Balance Validation","description":"A check definition to validate portfolio balances are within expected ranges","datasetSchema":{"type":"LusidEntity","entityType":"Portfolios"},"ruleSets":[{"ruleSetKey":"PositiveBalanceRule","displayName":"BalanceRuleSet","description":"Rules for validating portfolio balance data","ruleSetFilter":"Portfolio.Properties[Portfolio/DataQuality/Type] eq 'Equity'"}],"properties":{"CheckDefinition/DataQuality/Priority":{"key":"CheckDefinition/DataQuality/Priority","value":{"labelValue":"High"},"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","effectiveUntil":"2025-12-31T23:59:59.0000000+00:00"}}}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateCheckDefinitionRequest"},"example":{"id":{"scope":"DataQuality","code":"PortfolioBalanceCheck"},"displayName":"Portfolio Balance Validation","description":"A check definition to validate portfolio balances are within expected ranges","datasetSchema":{"type":"LusidEntity","entityType":"Portfolios"},"ruleSets":[{"ruleSetKey":"PositiveBalanceRule","displayName":"BalanceRuleSet","description":"Rules for validating portfolio balance data","ruleSetFilter":"Portfolio.Properties[Portfolio/DataQuality/Type] eq 'Equity'"}],"properties":{"CheckDefinition/DataQuality/Priority":{"key":"CheckDefinition/DataQuality/Priority","value":{"labelValue":"High"},"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","effectiveUntil":"2025-12-31T23:59:59.0000000+00:00"}}}}}},"responses":{"201":{"description":"The created Check Definition","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CheckDefinition"},"example":{"id":{"scope":"DataQuality","code":"PortfolioBalanceCheck"},"displayName":"Portfolio Balance Validation","description":"A check definition to validate portfolio balances are within expected ranges","datasetSchema":{"type":"LusidEntity","entityType":"Portfolios"},"ruleSets":[{"ruleSetKey":"BalanceRuleSet","displayName":"BalanceRuleSet","description":"Rules for validating portfolio balance data","ruleSetFilter":"Properties[Instrument/DataQuality/Type] eq 'Equity'","rules":[{"ruleKey":"PositiveBalanceRule","displayName":"PositiveBalanceRule","description":"Ensures portfolio balances are positive","ruleFormula":"Holdings.Sum(h => h.Units * h.Cost.Amount) > 0","severity":2},{"ruleKey":"ReasonableBalanceRule","displayName":"ReasonableBalanceRule","description":"Ensures portfolio balances are within reasonable limits","ruleFormula":"Holdings.Sum(h => h.Units * h.Cost.Amount) < 1000000000","severity":2}]}],"href":"https://lusid.company.com/api/checkdefinitions/DataQuality/PortfolioBalanceCheck","version":{"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","asAtDate":"2024-01-01T00:00:00.0000000+00:00","asAtCreated":"2024-01-01T00:00:00.0000000+00:00","userIdCreated":"userId","requestIdCreated":"requestId","reasonCreated":"","asAtModified":"2024-01-01T00:00:00.0000000+00:00","userIdModified":"userId","requestIdModified":"userId","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"},"properties":{"CheckDefinition/DataQuality/Priority":{"key":"CheckDefinition/DataQuality/Priority","value":{"labelValue":"High"},"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","effectiveUntil":"2025-12-31T23:59:59.0000000+00:00"}}}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CheckDefinition"},"example":{"id":{"scope":"DataQuality","code":"PortfolioBalanceCheck"},"displayName":"Portfolio Balance Validation","description":"A check definition to validate portfolio balances are within expected ranges","datasetSchema":{"type":"LusidEntity","entityType":"Portfolios"},"ruleSets":[{"ruleSetKey":"BalanceRuleSet","displayName":"BalanceRuleSet","description":"Rules for validating portfolio balance data","ruleSetFilter":"Properties[Instrument/DataQuality/Type] eq 'Equity'","rules":[{"ruleKey":"PositiveBalanceRule","displayName":"PositiveBalanceRule","description":"Ensures portfolio balances are positive","ruleFormula":"Holdings.Sum(h => h.Units * h.Cost.Amount) > 0","severity":2},{"ruleKey":"ReasonableBalanceRule","displayName":"ReasonableBalanceRule","description":"Ensures portfolio balances are within reasonable limits","ruleFormula":"Holdings.Sum(h => h.Units * h.Cost.Amount) < 1000000000","severity":2}]}],"href":"https://lusid.company.com/api/checkdefinitions/DataQuality/PortfolioBalanceCheck","version":{"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","asAtDate":"2024-01-01T00:00:00.0000000+00:00","asAtCreated":"2024-01-01T00:00:00.0000000+00:00","userIdCreated":"userId","requestIdCreated":"requestId","reasonCreated":"","asAtModified":"2024-01-01T00:00:00.0000000+00:00","userIdModified":"userId","requestIdModified":"userId","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"},"properties":{"CheckDefinition/DataQuality/Priority":{"key":"CheckDefinition/DataQuality/Priority","value":{"labelValue":"High"},"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","effectiveUntil":"2025-12-31T23:59:59.0000000+00:00"}}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CheckDefinition"},"example":{"id":{"scope":"DataQuality","code":"PortfolioBalanceCheck"},"displayName":"Portfolio Balance Validation","description":"A check definition to validate portfolio balances are within expected ranges","datasetSchema":{"type":"LusidEntity","entityType":"Portfolios"},"ruleSets":[{"ruleSetKey":"BalanceRuleSet","displayName":"BalanceRuleSet","description":"Rules for validating portfolio balance data","ruleSetFilter":"Properties[Instrument/DataQuality/Type] eq 'Equity'","rules":[{"ruleKey":"PositiveBalanceRule","displayName":"PositiveBalanceRule","description":"Ensures portfolio balances are positive","ruleFormula":"Holdings.Sum(h => h.Units * h.Cost.Amount) > 0","severity":2},{"ruleKey":"ReasonableBalanceRule","displayName":"ReasonableBalanceRule","description":"Ensures portfolio balances are within reasonable limits","ruleFormula":"Holdings.Sum(h => h.Units * h.Cost.Amount) < 1000000000","severity":2}]}],"href":"https://lusid.company.com/api/checkdefinitions/DataQuality/PortfolioBalanceCheck","version":{"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","asAtDate":"2024-01-01T00:00:00.0000000+00:00","asAtCreated":"2024-01-01T00:00:00.0000000+00:00","userIdCreated":"userId","requestIdCreated":"requestId","reasonCreated":"","asAtModified":"2024-01-01T00:00:00.0000000+00:00","userIdModified":"userId","requestIdModified":"userId","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"},"properties":{"CheckDefinition/DataQuality/Priority":{"key":"CheckDefinition/DataQuality/Priority","value":{"labelValue":"High"},"effectiveFrom":"2024-01-01T00:00:00.0000000+00:00","effectiveUntil":"2025-12-31T23:59:59.0000000+00:00"}}}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"Experimental"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}