{"openapi":"3.0.4","info":{"title":"Upsert Reference List","description":"Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/referencelists":{"post":{"tags":["ReferenceLists"],"summary":"Upsert Reference List","description":"Insert the Reference List if it does not exist or update the Reference List with the supplied state if it does exist.","operationId":"UpsertReferenceList","requestBody":{"description":"The payload describing the Reference List instance.","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ReferenceListRequest"},"examples":{"Create String Reference List":{"value":{"id":{"scope":"MyScope","code":"MyStringList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["value1","value2"],"referenceListType":"StringList"}}},"Create PortfolioId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioIdList"}}},"Create PortfolioGroupId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioGroupIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioGroupIdList"}}},"Create AddressKey Reference List":{"value":{"id":{"scope":"MyScope","code":"MyAddressKeyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["Valuation/PV","Instrument/Properties[Instrument/default/Name]"],"referenceListType":"AddressKeyList"}}},"Create Property Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPropertyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"key":"Instrument/default/Isin","value":{"labelValue":"123456789"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"},{"key":"Instrument/default/Figi","value":{"labelValue":"987654321"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"}],"referenceListType":"PropertyList"}}},"Create Instrument Reference List":{"value":{"id":{"scope":"MyScope","code":"MyInstrumentList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["LUID_12345678","LUID_23456789"],"referenceListType":"InstrumentList"}}},"Create Decimal Reference List":{"value":{"id":{"scope":"MyScope","code":"MyDecimalList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[1,2],"referenceListType":"DecimalList"}}},"Create FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"FundIdList"}}},"Create Filtered FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFilteredFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"filter":"Id.Scope eq 'FundScope1'","referenceListType":"FilteredFundIdList"}}}}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ReferenceListRequest"},"examples":{"Create String Reference List":{"value":{"id":{"scope":"MyScope","code":"MyStringList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["value1","value2"],"referenceListType":"StringList"}}},"Create PortfolioId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioIdList"}}},"Create PortfolioGroupId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioGroupIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioGroupIdList"}}},"Create AddressKey Reference List":{"value":{"id":{"scope":"MyScope","code":"MyAddressKeyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["Valuation/PV","Instrument/Properties[Instrument/default/Name]"],"referenceListType":"AddressKeyList"}}},"Create Property Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPropertyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"key":"Instrument/default/Isin","value":{"labelValue":"123456789"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"},{"key":"Instrument/default/Figi","value":{"labelValue":"987654321"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"}],"referenceListType":"PropertyList"}}},"Create Instrument Reference List":{"value":{"id":{"scope":"MyScope","code":"MyInstrumentList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["LUID_12345678","LUID_23456789"],"referenceListType":"InstrumentList"}}},"Create Decimal Reference List":{"value":{"id":{"scope":"MyScope","code":"MyDecimalList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[1,2],"referenceListType":"DecimalList"}}},"Create FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"FundIdList"}}},"Create Filtered FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFilteredFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"filter":"Id.Scope eq 'FundScope1'","referenceListType":"FilteredFundIdList"}}}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ReferenceListRequest"},"examples":{"Create String Reference List":{"value":{"id":{"scope":"MyScope","code":"MyStringList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["value1","value2"],"referenceListType":"StringList"}}},"Create PortfolioId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioIdList"}}},"Create PortfolioGroupId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioGroupIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioGroupIdList"}}},"Create AddressKey Reference List":{"value":{"id":{"scope":"MyScope","code":"MyAddressKeyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["Valuation/PV","Instrument/Properties[Instrument/default/Name]"],"referenceListType":"AddressKeyList"}}},"Create Property Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPropertyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"key":"Instrument/default/Isin","value":{"labelValue":"123456789"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"},{"key":"Instrument/default/Figi","value":{"labelValue":"987654321"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"}],"referenceListType":"PropertyList"}}},"Create Instrument Reference List":{"value":{"id":{"scope":"MyScope","code":"MyInstrumentList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["LUID_12345678","LUID_23456789"],"referenceListType":"InstrumentList"}}},"Create Decimal Reference List":{"value":{"id":{"scope":"MyScope","code":"MyDecimalList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[1,2],"referenceListType":"DecimalList"}}},"Create FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"FundIdList"}}},"Create Filtered FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFilteredFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"filter":"Id.Scope eq 'FundScope1'","referenceListType":"FilteredFundIdList"}}}}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ReferenceListRequest"},"examples":{"Create String Reference List":{"value":{"id":{"scope":"MyScope","code":"MyStringList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["value1","value2"],"referenceListType":"StringList"}}},"Create PortfolioId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioIdList"}}},"Create PortfolioGroupId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPortfolioGroupIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"PortfolioGroupIdList"}}},"Create AddressKey Reference List":{"value":{"id":{"scope":"MyScope","code":"MyAddressKeyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["Valuation/PV","Instrument/Properties[Instrument/default/Name]"],"referenceListType":"AddressKeyList"}}},"Create Property Reference List":{"value":{"id":{"scope":"MyScope","code":"MyPropertyList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"key":"Instrument/default/Isin","value":{"labelValue":"123456789"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"},{"key":"Instrument/default/Figi","value":{"labelValue":"987654321"},"effectiveFrom":"0001-01-01T00:00:00.0000000+00:00"}],"referenceListType":"PropertyList"}}},"Create Instrument Reference List":{"value":{"id":{"scope":"MyScope","code":"MyInstrumentList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":["LUID_12345678","LUID_23456789"],"referenceListType":"InstrumentList"}}},"Create Decimal Reference List":{"value":{"id":{"scope":"MyScope","code":"MyDecimalList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[1,2],"referenceListType":"DecimalList"}}},"Create FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"values":[{"scope":"scope1","code":"code1"},{"scope":"scope2","code":"code2"}],"referenceListType":"FundIdList"}}},"Create Filtered FundId Reference List":{"value":{"id":{"scope":"MyScope","code":"MyFilteredFundIdList"},"name":"MyReferenceListName","description":"My reference list description","tags":["tags","associated","with","my","list"],"referenceList":{"filter":"Id.Scope eq 'FundScope1'","referenceListType":"FilteredFundIdList"}}}}}}},"responses":{"200":{"description":"The upserted Reference List instance.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ReferenceListResponse"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ReferenceListResponse"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/ReferenceListResponse"}}}},"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"}}}}