{"openapi":"3.0.4","info":{"title":"CreateMatchingRuleset","description":"Create a matching ruleset, describing the core and aggregate rules used to match a reconciliation's two sides.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/recs/matchingrulesets":{"post":{"tags":["Recs"],"summary":"CreateMatchingRuleset","description":"Create a matching ruleset, describing the core and aggregate rules used to match a reconciliation's two sides.","operationId":"CreateMatchingRuleset","requestBody":{"description":"The matching ruleset to create.","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateMatchingRulesetRequest"},"example":{"id":{"scope":"Recs","code":"CustodyHoldingRules"},"displayName":"Custody Holding Rules","recType":"Holding","datasetSchemas":{"right":{"type":"RelationalData","relationalDatasetDefinitionId":{"scope":"Custody","code":"CustodianPositions"}}},"filters":{"left":"holdingType eq 'P'","right":"positionType eq 'STOCK'"},"coreRules":[{"ruleName":"Instrument","leftFormula":"Properties[Instrument/default/Isin]","rightFormula":"isin","isCaseSensitive":false}],"aggregateRules":[{"ruleName":"Units","leftFormula":"units","leftOperation":"Sum","rightFormula":"quantity","rightOperation":"Sum"}],"aggregateTolerances":[{"referenceSide":"Left","relativeThreshold":0.01,"thresholdPriority":"GreaterOf","offset":"Either","toleranceType":"Numeric","ruleName":"Units"}],"allowPartialMatching":true,"supplementalAttributes":[{"attributeName":"Custodian","leftFormula":"Properties[Custody/default/CustodianCode]","rightFormula":"custodian"}],"populateResultProperties":[{"propertyKey":"RecResult/Recs/RemediationQueue","formula":"'HoldingBreaks'","overwriteManualEditsOnReRun":false}]}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateMatchingRulesetRequest"},"example":{"id":{"scope":"Recs","code":"CustodyHoldingRules"},"displayName":"Custody Holding Rules","recType":"Holding","datasetSchemas":{"right":{"type":"RelationalData","relationalDatasetDefinitionId":{"scope":"Custody","code":"CustodianPositions"}}},"filters":{"left":"holdingType eq 'P'","right":"positionType eq 'STOCK'"},"coreRules":[{"ruleName":"Instrument","leftFormula":"Properties[Instrument/default/Isin]","rightFormula":"isin","isCaseSensitive":false}],"aggregateRules":[{"ruleName":"Units","leftFormula":"units","leftOperation":"Sum","rightFormula":"quantity","rightOperation":"Sum"}],"aggregateTolerances":[{"referenceSide":"Left","relativeThreshold":0.01,"thresholdPriority":"GreaterOf","offset":"Either","toleranceType":"Numeric","ruleName":"Units"}],"allowPartialMatching":true,"supplementalAttributes":[{"attributeName":"Custodian","leftFormula":"Properties[Custody/default/CustodianCode]","rightFormula":"custodian"}],"populateResultProperties":[{"propertyKey":"RecResult/Recs/RemediationQueue","formula":"'HoldingBreaks'","overwriteManualEditsOnReRun":false}]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateMatchingRulesetRequest"},"example":{"id":{"scope":"Recs","code":"CustodyHoldingRules"},"displayName":"Custody Holding Rules","recType":"Holding","datasetSchemas":{"right":{"type":"RelationalData","relationalDatasetDefinitionId":{"scope":"Custody","code":"CustodianPositions"}}},"filters":{"left":"holdingType eq 'P'","right":"positionType eq 'STOCK'"},"coreRules":[{"ruleName":"Instrument","leftFormula":"Properties[Instrument/default/Isin]","rightFormula":"isin","isCaseSensitive":false}],"aggregateRules":[{"ruleName":"Units","leftFormula":"units","leftOperation":"Sum","rightFormula":"quantity","rightOperation":"Sum"}],"aggregateTolerances":[{"referenceSide":"Left","relativeThreshold":0.01,"thresholdPriority":"GreaterOf","offset":"Either","toleranceType":"Numeric","ruleName":"Units"}],"allowPartialMatching":true,"supplementalAttributes":[{"attributeName":"Custodian","leftFormula":"Properties[Custody/default/CustodianCode]","rightFormula":"custodian"}],"populateResultProperties":[{"propertyKey":"RecResult/Recs/RemediationQueue","formula":"'HoldingBreaks'","overwriteManualEditsOnReRun":false}]}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CreateMatchingRulesetRequest"},"example":{"id":{"scope":"Recs","code":"CustodyHoldingRules"},"displayName":"Custody Holding Rules","recType":"Holding","datasetSchemas":{"right":{"type":"RelationalData","relationalDatasetDefinitionId":{"scope":"Custody","code":"CustodianPositions"}}},"filters":{"left":"holdingType eq 'P'","right":"positionType eq 'STOCK'"},"coreRules":[{"ruleName":"Instrument","leftFormula":"Properties[Instrument/default/Isin]","rightFormula":"isin","isCaseSensitive":false}],"aggregateRules":[{"ruleName":"Units","leftFormula":"units","leftOperation":"Sum","rightFormula":"quantity","rightOperation":"Sum"}],"aggregateTolerances":[{"referenceSide":"Left","relativeThreshold":0.01,"thresholdPriority":"GreaterOf","offset":"Either","toleranceType":"Numeric","ruleName":"Units"}],"allowPartialMatching":true,"supplementalAttributes":[{"attributeName":"Custodian","leftFormula":"Properties[Custody/default/CustodianCode]","rightFormula":"custodian"}],"populateResultProperties":[{"propertyKey":"RecResult/Recs/RemediationQueue","formula":"'HoldingBreaks'","overwriteManualEditsOnReRun":false}]}}},"required":true},"responses":{"201":{"description":"The newly created matching ruleset.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/MatchingRuleset"},"example":{"id":{"scope":"Recs","code":"CustodyHoldingRules"},"displayName":"Custody Holding Rules","recType":"Holding","datasetSchemas":{"left":{"type":"PortfolioContents","entityType":"Holding"},"right":{"type":"RelationalData","relationalDatasetDefinitionId":{"scope":"Custody","code":"CustodianPositions"}}},"filters":{"left":"holdingType eq 'P'","right":"positionType eq 'STOCK'"},"coreRules":[{"ruleName":"Instrument","leftFormula":"Properties[Instrument/default/Isin]","rightFormula":"isin","isCaseSensitive":false}],"aggregateRules":[{"ruleName":"Units","leftFormula":"units","leftOperation":"Sum","rightFormula":"quantity","rightOperation":"Sum"}],"aggregateTolerances":[{"referenceSide":"Left","relativeThreshold":0.01,"thresholdPriority":"GreaterOf","offset":"Either","toleranceType":"Numeric","ruleName":"Units"}],"allowPartialMatching":true,"supplementalAttributes":[{"attributeName":"Custodian","leftFormula":"Properties[Custody/default/CustodianCode]","rightFormula":"custodian"}],"populateResultProperties":[{"propertyKey":"RecResult/Recs/RemediationQueue","formula":"'HoldingBreaks'","overwriteManualEditsOnReRun":false}],"href":"https://example.com","version":{"effectiveFrom":"2024-06-01T00:00:00.0000000+00:00","asAtDate":"2024-06-01T10:30:00.0000000+00:00"}}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/MatchingRuleset"},"example":{"id":{"scope":"Recs","code":"CustodyHoldingRules"},"displayName":"Custody Holding Rules","recType":"Holding","datasetSchemas":{"left":{"type":"PortfolioContents","entityType":"Holding"},"right":{"type":"RelationalData","relationalDatasetDefinitionId":{"scope":"Custody","code":"CustodianPositions"}}},"filters":{"left":"holdingType eq 'P'","right":"positionType eq 'STOCK'"},"coreRules":[{"ruleName":"Instrument","leftFormula":"Properties[Instrument/default/Isin]","rightFormula":"isin","isCaseSensitive":false}],"aggregateRules":[{"ruleName":"Units","leftFormula":"units","leftOperation":"Sum","rightFormula":"quantity","rightOperation":"Sum"}],"aggregateTolerances":[{"referenceSide":"Left","relativeThreshold":0.01,"thresholdPriority":"GreaterOf","offset":"Either","toleranceType":"Numeric","ruleName":"Units"}],"allowPartialMatching":true,"supplementalAttributes":[{"attributeName":"Custodian","leftFormula":"Properties[Custody/default/CustodianCode]","rightFormula":"custodian"}],"populateResultProperties":[{"propertyKey":"RecResult/Recs/RemediationQueue","formula":"'HoldingBreaks'","overwriteManualEditsOnReRun":false}],"href":"https://example.com","version":{"effectiveFrom":"2024-06-01T00:00:00.0000000+00:00","asAtDate":"2024-06-01T10:30:00.0000000+00:00"}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/MatchingRuleset"},"example":{"id":{"scope":"Recs","code":"CustodyHoldingRules"},"displayName":"Custody Holding Rules","recType":"Holding","datasetSchemas":{"left":{"type":"PortfolioContents","entityType":"Holding"},"right":{"type":"RelationalData","relationalDatasetDefinitionId":{"scope":"Custody","code":"CustodianPositions"}}},"filters":{"left":"holdingType eq 'P'","right":"positionType eq 'STOCK'"},"coreRules":[{"ruleName":"Instrument","leftFormula":"Properties[Instrument/default/Isin]","rightFormula":"isin","isCaseSensitive":false}],"aggregateRules":[{"ruleName":"Units","leftFormula":"units","leftOperation":"Sum","rightFormula":"quantity","rightOperation":"Sum"}],"aggregateTolerances":[{"referenceSide":"Left","relativeThreshold":0.01,"thresholdPriority":"GreaterOf","offset":"Either","toleranceType":"Numeric","ruleName":"Units"}],"allowPartialMatching":true,"supplementalAttributes":[{"attributeName":"Custodian","leftFormula":"Properties[Custody/default/CustodianCode]","rightFormula":"custodian"}],"populateResultProperties":[{"propertyKey":"RecResult/Recs/RemediationQueue","formula":"'HoldingBreaks'","overwriteManualEditsOnReRun":false}],"href":"https://example.com","version":{"effectiveFrom":"2024-06-01T00:00:00.0000000+00:00","asAtDate":"2024-06-01T10:30:00.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"}}}}