{"openapi":"3.0.4","info":{"title":"Upsert a compliance rule.","description":"Use this endpoint to upsert a single compliance rule. The template and variation specified must already\r\nexist, as must the portfolio group. The parameters passed must match those required by the template variation.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/compliance/rules":{"post":{"tags":["Compliance"],"summary":"Upsert a compliance rule.","description":"Use this endpoint to upsert a single compliance rule. The template and variation specified must already\r\nexist, as must the portfolio group. The parameters passed must match those required by the template variation.","operationId":"UpsertComplianceRule","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertComplianceRuleRequest"},"examples":{"Example with all parameter types":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"BoolParameter":{"value":true,"complianceParameterType":"BoolComplianceParameter"},"DecimalParameter":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"StringParameter":{"value":"An example string parameter","complianceParameterType":"StringComplianceParameter"},"DateTimeParameter":{"value":"2023-06-06T00:00:00.0000000+00:00","complianceParameterType":"DateTimeComplianceParameter"},"PropertyKeyParameter":{"value":"Compliance/live/RuleGroup","complianceParameterType":"PropertyKeyComplianceParameter"},"AddressKeyParameter":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"PortfolioIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdComplianceParameter"},"PortfolioGroupIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdComplianceParameter"},"DecimalListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DecimalListComplianceParameter"},"AddressKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"AddressKeyListComplianceParameter"},"BoolListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"BoolListComplianceParameter"},"StringListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"DateTimeListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DateTimeListComplianceParameter"},"PropertyKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PropertyKeyListComplianceParameter"},"PortfolioIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"},"PortfolioGroupIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}},"PercentCheck example":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"UpperBound":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerBound":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"UpperWarning":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerWarning":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"Metric":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"FirstFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"SecondFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"FirstFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"SecondFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"GroupingPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"Excludes":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}}}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertComplianceRuleRequest"},"examples":{"Example with all parameter types":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"BoolParameter":{"value":true,"complianceParameterType":"BoolComplianceParameter"},"DecimalParameter":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"StringParameter":{"value":"An example string parameter","complianceParameterType":"StringComplianceParameter"},"DateTimeParameter":{"value":"2023-06-06T00:00:00.0000000+00:00","complianceParameterType":"DateTimeComplianceParameter"},"PropertyKeyParameter":{"value":"Compliance/live/RuleGroup","complianceParameterType":"PropertyKeyComplianceParameter"},"AddressKeyParameter":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"PortfolioIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdComplianceParameter"},"PortfolioGroupIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdComplianceParameter"},"DecimalListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DecimalListComplianceParameter"},"AddressKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"AddressKeyListComplianceParameter"},"BoolListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"BoolListComplianceParameter"},"StringListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"DateTimeListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DateTimeListComplianceParameter"},"PropertyKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PropertyKeyListComplianceParameter"},"PortfolioIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"},"PortfolioGroupIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}},"PercentCheck example":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"UpperBound":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerBound":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"UpperWarning":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerWarning":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"Metric":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"FirstFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"SecondFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"FirstFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"SecondFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"GroupingPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"Excludes":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertComplianceRuleRequest"},"examples":{"Example with all parameter types":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"BoolParameter":{"value":true,"complianceParameterType":"BoolComplianceParameter"},"DecimalParameter":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"StringParameter":{"value":"An example string parameter","complianceParameterType":"StringComplianceParameter"},"DateTimeParameter":{"value":"2023-06-06T00:00:00.0000000+00:00","complianceParameterType":"DateTimeComplianceParameter"},"PropertyKeyParameter":{"value":"Compliance/live/RuleGroup","complianceParameterType":"PropertyKeyComplianceParameter"},"AddressKeyParameter":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"PortfolioIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdComplianceParameter"},"PortfolioGroupIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdComplianceParameter"},"DecimalListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DecimalListComplianceParameter"},"AddressKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"AddressKeyListComplianceParameter"},"BoolListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"BoolListComplianceParameter"},"StringListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"DateTimeListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DateTimeListComplianceParameter"},"PropertyKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PropertyKeyListComplianceParameter"},"PortfolioIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"},"PortfolioGroupIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}},"PercentCheck example":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"UpperBound":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerBound":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"UpperWarning":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerWarning":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"Metric":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"FirstFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"SecondFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"FirstFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"SecondFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"GroupingPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"Excludes":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}}}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertComplianceRuleRequest"},"examples":{"Example with all parameter types":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"BoolParameter":{"value":true,"complianceParameterType":"BoolComplianceParameter"},"DecimalParameter":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"StringParameter":{"value":"An example string parameter","complianceParameterType":"StringComplianceParameter"},"DateTimeParameter":{"value":"2023-06-06T00:00:00.0000000+00:00","complianceParameterType":"DateTimeComplianceParameter"},"PropertyKeyParameter":{"value":"Compliance/live/RuleGroup","complianceParameterType":"PropertyKeyComplianceParameter"},"AddressKeyParameter":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"PortfolioIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdComplianceParameter"},"PortfolioGroupIdParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdComplianceParameter"},"DecimalListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DecimalListComplianceParameter"},"AddressKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"AddressKeyListComplianceParameter"},"BoolListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"BoolListComplianceParameter"},"StringListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"DateTimeListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"DateTimeListComplianceParameter"},"PropertyKeyListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PropertyKeyListComplianceParameter"},"PortfolioIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"},"PortfolioGroupIdListParameter":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioGroupIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}},"PercentCheck example":{"value":{"id":{"scope":"live","code":"exampleRule"},"name":"A friendly name.","description":"A friendly description.","active":true,"templateId":{"scope":"system","code":"PercentCheck"},"variation":"standard","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"UpperBound":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerBound":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"UpperWarning":{"value":15,"complianceParameterType":"DecimalComplianceParameter"},"LowerWarning":{"value":0,"complianceParameterType":"DecimalComplianceParameter"},"Metric":{"value":"Valuation/PvInReportCcy","complianceParameterType":"AddressKeyComplianceParameter"},"FirstFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"SecondFilterPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"FirstFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"SecondFilterPermittedValuesList":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"StringListComplianceParameter"},"GroupingPropertyKey":{"value":"Portfolio/default/Name","complianceParameterType":"PropertyKeyComplianceParameter"},"Excludes":{"value":{"scope":"testscope","code":"testcode"},"complianceParameterType":"PortfolioIdListComplianceParameter"}},"properties":{"Compliance/MyScope/SomeRuleProperty":{"key":"Compliance/MyScope/SomeRuleProperty","value":{"labelValue":"XYZ000034567"}}}}}}}}},"responses":{"200":{"description":"The upserted compliance rule.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ComplianceRuleResponse"},"example":{"id":{"scope":"examples","code":"exampleRule"},"name":"A friendly example rule name.","description":"An friendly description example.","active":true,"templateId":{"scope":"live","code":"exampleTemplate"},"variation":"Single","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"UpperBound":{"value":30,"complianceParameterType":"DecimalComplianceParameter"}},"properties":{"Compliance/MyScope/SomeOrderProperty":{"key":"Compliance/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"version":{"effectiveFrom":"2018-03-05T10:10:10.0000000+00:00","asAtDate":"2018-03-05T10:10:10.0000000+00:00","asAtCreated":"2018-03-05T10:10:10.0000000+00:00","userIdCreated":"User1","requestIdCreated":"RequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"User2","requestIdModified":"RequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"},"links":[]}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ComplianceRuleResponse"},"example":{"id":{"scope":"examples","code":"exampleRule"},"name":"A friendly example rule name.","description":"An friendly description example.","active":true,"templateId":{"scope":"live","code":"exampleTemplate"},"variation":"Single","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"UpperBound":{"value":30,"complianceParameterType":"DecimalComplianceParameter"}},"properties":{"Compliance/MyScope/SomeOrderProperty":{"key":"Compliance/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"version":{"effectiveFrom":"2018-03-05T10:10:10.0000000+00:00","asAtDate":"2018-03-05T10:10:10.0000000+00:00","asAtCreated":"2018-03-05T10:10:10.0000000+00:00","userIdCreated":"User1","requestIdCreated":"RequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"User2","requestIdModified":"RequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"},"links":[]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ComplianceRuleResponse"},"example":{"id":{"scope":"examples","code":"exampleRule"},"name":"A friendly example rule name.","description":"An friendly description example.","active":true,"templateId":{"scope":"live","code":"exampleTemplate"},"variation":"Single","portfolioGroupId":{"scope":"examples","code":"examplePortfolioGroup"},"parameters":{"UpperBound":{"value":30,"complianceParameterType":"DecimalComplianceParameter"}},"properties":{"Compliance/MyScope/SomeOrderProperty":{"key":"Compliance/MyScope/SomeOrderProperty","value":{"labelValue":"XYZ000034567"}}},"version":{"effectiveFrom":"2018-03-05T10:10:10.0000000+00:00","asAtDate":"2018-03-05T10:10:10.0000000+00:00","asAtCreated":"2018-03-05T10:10:10.0000000+00:00","userIdCreated":"User1","requestIdCreated":"RequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"User2","requestIdModified":"RequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"},"links":[]}}}},"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":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}