{"openapi":"3.0.4","info":{"title":"Update a Custom Data Model","description":"Updates a Custom Data Model.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/datamodel/{entityType}/{scope}/{code}":{"put":{"tags":["Custom Data Models"],"summary":"Update a Custom Data Model","description":"Updates a Custom Data Model.","operationId":"UpdateCustomDataModel","parameters":[{"name":"entityType","in":"path","description":"The entity type of the Data Model.","required":true,"schema":{"maxLength":64,"minLength":1,"type":"string"}},{"name":"scope","in":"path","description":"The scope of the specified Data Model.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string","readOnly":true}},{"name":"code","in":"path","description":"The code of the specified Data Model.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}}],"requestBody":{"description":"The request containing the details of the Data Model.","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpdateCustomDataModelRequest"},"example":{"displayName":"DisplayName","description":"description","parentDataModel":{"scope":"ParentScope","code":"ParentCode"},"conditions":"AssetClass eq 'Credit'","properties":[{"propertyKey":"Calendar/TestScope/DummyCalendarKey","required":true},{"propertyKey":"Holding/TestScope/DummyHoldingKey1","required":false}],"identifierTypes":[{"identifierKey":"CustomEntity/TestScope/DummyCustomEntityKey1","required":true},{"identifierKey":"Person/TestScope/DummyPersonKey1","required":false}],"attributeAliases":[{"attributeName":"Properties[Calendar/TestScope/DummyCalendarKey]","attributeAlias":"cp"}],"recommendedSortBy":[{"attributeName":"Identifiers[CustomEntity/TestScope/DummyCustomEntityKey1]","sortOrder":"ASC"}],"supplementalPropertyKeys":[]}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpdateCustomDataModelRequest"},"example":{"displayName":"DisplayName","description":"description","parentDataModel":{"scope":"ParentScope","code":"ParentCode"},"conditions":"AssetClass eq 'Credit'","properties":[{"propertyKey":"Calendar/TestScope/DummyCalendarKey","required":true},{"propertyKey":"Holding/TestScope/DummyHoldingKey1","required":false}],"identifierTypes":[{"identifierKey":"CustomEntity/TestScope/DummyCustomEntityKey1","required":true},{"identifierKey":"Person/TestScope/DummyPersonKey1","required":false}],"attributeAliases":[{"attributeName":"Properties[Calendar/TestScope/DummyCalendarKey]","attributeAlias":"cp"}],"recommendedSortBy":[{"attributeName":"Identifiers[CustomEntity/TestScope/DummyCustomEntityKey1]","sortOrder":"ASC"}],"supplementalPropertyKeys":[]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpdateCustomDataModelRequest"},"example":{"displayName":"DisplayName","description":"description","parentDataModel":{"scope":"ParentScope","code":"ParentCode"},"conditions":"AssetClass eq 'Credit'","properties":[{"propertyKey":"Calendar/TestScope/DummyCalendarKey","required":true},{"propertyKey":"Holding/TestScope/DummyHoldingKey1","required":false}],"identifierTypes":[{"identifierKey":"CustomEntity/TestScope/DummyCustomEntityKey1","required":true},{"identifierKey":"Person/TestScope/DummyPersonKey1","required":false}],"attributeAliases":[{"attributeName":"Properties[Calendar/TestScope/DummyCalendarKey]","attributeAlias":"cp"}],"recommendedSortBy":[{"attributeName":"Identifiers[CustomEntity/TestScope/DummyCustomEntityKey1]","sortOrder":"ASC"}],"supplementalPropertyKeys":[]}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpdateCustomDataModelRequest"},"example":{"displayName":"DisplayName","description":"description","parentDataModel":{"scope":"ParentScope","code":"ParentCode"},"conditions":"AssetClass eq 'Credit'","properties":[{"propertyKey":"Calendar/TestScope/DummyCalendarKey","required":true},{"propertyKey":"Holding/TestScope/DummyHoldingKey1","required":false}],"identifierTypes":[{"identifierKey":"CustomEntity/TestScope/DummyCustomEntityKey1","required":true},{"identifierKey":"Person/TestScope/DummyPersonKey1","required":false}],"attributeAliases":[{"attributeName":"Properties[Calendar/TestScope/DummyCalendarKey]","attributeAlias":"cp"}],"recommendedSortBy":[{"attributeName":"Identifiers[CustomEntity/TestScope/DummyCustomEntityKey1]","sortOrder":"ASC"}],"supplementalPropertyKeys":[]}}}},"responses":{"200":{"description":"The updated Data Model","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CustomDataModel"},"example":{"dataModelSummary":{"id":{"scope":"TestScope","code":"parent"},"displayName":"Parent","description":"description","entityType":"Instrument","type":"Root","precedence":0,"children":[{"id":{"scope":"TestScope","code":"child"},"displayName":"Child","description":"description","entityType":"Instrument","type":"Child","precedence":0,"parent":{"scope":"TestScope","code":"parent"},"children":[]}]},"inherited":{"conditions":["assetClass eq 'Credit'"],"properties":[{"displayName":"","propertyKey":"Instrument/default/*","required":false}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Isin","required":false,"identifierType":"Isin"}],"attributeAliases":[{"attributeName":"firstCouponPayDate","attributeAlias":"InitialCouponDate"}],"recommendedSortBy":[],"supplementalPropertyKeys":["Instrument/Production/Description"]},"incremental":{"conditions":["InstrumentDefinition.InstrumentType eq 'bond'"],"properties":[{"displayName":"","propertyKey":"Instrument/Production/ExchangeCode","required":true},{"displayName":"","propertyKey":"Instrument/Production/ExchangeLocation","required":true}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Cusip","required":true,"identifierType":"Cusip"}],"attributeAliases":[],"recommendedSortBy":[{"attributeName":"Properties[Instrument/Production/ExchangeLocation]","sortOrder":"ASC"}],"supplementalPropertyKeys":["Instrument/Production/Description"]},"applied":{"conditions":["assetClass eq 'Credit'","InstrumentDefinition.InstrumentType eq 'Bond'"],"properties":[{"displayName":"","propertyKey":"Instrument/Production/ExchangeCode","required":true},{"displayName":"","propertyKey":"Instrument/Production/ExchangeLocation","required":true},{"displayName":"","propertyKey":"Instrument/default/*","required":false}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Isin","required":true,"identifierType":"Isin"},{"displayName":"","identifierKey":"Instrument/default/Cusip","required":true,"identifierType":"Cusip"}],"attributeAliases":[{"attributeName":"firstCouponPayDate","attributeAlias":"InitialCouponDate"}],"recommendedSortBy":[{"attributeName":"Properties[Instrument/Production/ExchangeLocation]","sortOrder":"ASC"}],"supplementalPropertyKeys":["Instrument/Production/Description"]},"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":"CdmUser1","requestIdCreated":"CdmRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CdmUser2","requestIdModified":"CdmRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CustomDataModel"},"example":{"dataModelSummary":{"id":{"scope":"TestScope","code":"parent"},"displayName":"Parent","description":"description","entityType":"Instrument","type":"Root","precedence":0,"children":[{"id":{"scope":"TestScope","code":"child"},"displayName":"Child","description":"description","entityType":"Instrument","type":"Child","precedence":0,"parent":{"scope":"TestScope","code":"parent"},"children":[]}]},"inherited":{"conditions":["assetClass eq 'Credit'"],"properties":[{"displayName":"","propertyKey":"Instrument/default/*","required":false}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Isin","required":false,"identifierType":"Isin"}],"attributeAliases":[{"attributeName":"firstCouponPayDate","attributeAlias":"InitialCouponDate"}],"recommendedSortBy":[],"supplementalPropertyKeys":["Instrument/Production/Description"]},"incremental":{"conditions":["InstrumentDefinition.InstrumentType eq 'bond'"],"properties":[{"displayName":"","propertyKey":"Instrument/Production/ExchangeCode","required":true},{"displayName":"","propertyKey":"Instrument/Production/ExchangeLocation","required":true}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Cusip","required":true,"identifierType":"Cusip"}],"attributeAliases":[],"recommendedSortBy":[{"attributeName":"Properties[Instrument/Production/ExchangeLocation]","sortOrder":"ASC"}],"supplementalPropertyKeys":["Instrument/Production/Description"]},"applied":{"conditions":["assetClass eq 'Credit'","InstrumentDefinition.InstrumentType eq 'Bond'"],"properties":[{"displayName":"","propertyKey":"Instrument/Production/ExchangeCode","required":true},{"displayName":"","propertyKey":"Instrument/Production/ExchangeLocation","required":true},{"displayName":"","propertyKey":"Instrument/default/*","required":false}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Isin","required":true,"identifierType":"Isin"},{"displayName":"","identifierKey":"Instrument/default/Cusip","required":true,"identifierType":"Cusip"}],"attributeAliases":[{"attributeName":"firstCouponPayDate","attributeAlias":"InitialCouponDate"}],"recommendedSortBy":[{"attributeName":"Properties[Instrument/Production/ExchangeLocation]","sortOrder":"ASC"}],"supplementalPropertyKeys":["Instrument/Production/Description"]},"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":"CdmUser1","requestIdCreated":"CdmRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CdmUser2","requestIdModified":"CdmRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/CustomDataModel"},"example":{"dataModelSummary":{"id":{"scope":"TestScope","code":"parent"},"displayName":"Parent","description":"description","entityType":"Instrument","type":"Root","precedence":0,"children":[{"id":{"scope":"TestScope","code":"child"},"displayName":"Child","description":"description","entityType":"Instrument","type":"Child","precedence":0,"parent":{"scope":"TestScope","code":"parent"},"children":[]}]},"inherited":{"conditions":["assetClass eq 'Credit'"],"properties":[{"displayName":"","propertyKey":"Instrument/default/*","required":false}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Isin","required":false,"identifierType":"Isin"}],"attributeAliases":[{"attributeName":"firstCouponPayDate","attributeAlias":"InitialCouponDate"}],"recommendedSortBy":[],"supplementalPropertyKeys":["Instrument/Production/Description"]},"incremental":{"conditions":["InstrumentDefinition.InstrumentType eq 'bond'"],"properties":[{"displayName":"","propertyKey":"Instrument/Production/ExchangeCode","required":true},{"displayName":"","propertyKey":"Instrument/Production/ExchangeLocation","required":true}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Cusip","required":true,"identifierType":"Cusip"}],"attributeAliases":[],"recommendedSortBy":[{"attributeName":"Properties[Instrument/Production/ExchangeLocation]","sortOrder":"ASC"}],"supplementalPropertyKeys":["Instrument/Production/Description"]},"applied":{"conditions":["assetClass eq 'Credit'","InstrumentDefinition.InstrumentType eq 'Bond'"],"properties":[{"displayName":"","propertyKey":"Instrument/Production/ExchangeCode","required":true},{"displayName":"","propertyKey":"Instrument/Production/ExchangeLocation","required":true},{"displayName":"","propertyKey":"Instrument/default/*","required":false}],"identifierTypes":[{"displayName":"","identifierKey":"Instrument/default/Isin","required":true,"identifierType":"Isin"},{"displayName":"","identifierKey":"Instrument/default/Cusip","required":true,"identifierType":"Cusip"}],"attributeAliases":[{"attributeName":"firstCouponPayDate","attributeAlias":"InitialCouponDate"}],"recommendedSortBy":[{"attributeName":"Properties[Instrument/Production/ExchangeLocation]","sortOrder":"ASC"}],"supplementalPropertyKeys":["Instrument/Production/Description"]},"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":"CdmUser1","requestIdCreated":"CdmRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CdmUser2","requestIdModified":"CdmRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}}}},"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"}}}}