{"openapi":"3.0.4","info":{"title":"Batch Upsert Relational Data Points for a given Relational Dataset Definition.","description":"Batch Upsert Relational Data Points for a given Relational Dataset Definition.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/relationaldatasets/{relationalDatasetDefinitionScope}/{relationalDatasetDefinitionCode}/$batchUpsert":{"post":{"tags":["Relational Datasets"],"summary":"Batch Upsert Relational Data Points for a given Relational Dataset Definition.","description":"Batch Upsert Relational Data Points for a given Relational Dataset Definition.","operationId":"BatchUpsertRelationalData","parameters":[{"name":"relationalDatasetDefinitionScope","in":"path","description":"The Scope of the relational dataset definition.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"relationalDatasetDefinitionCode","in":"path","description":"The Code of the relational dataset definition.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"successMode","in":"query","description":"Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.\r\n            Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code.","schema":{"maxLength":64,"minLength":1,"type":"string","default":"Partial"}}],"requestBody":{"description":"The DataPoints to upsert.","content":{"application/json-patch+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertRelationalDataPointRequest"}},"example":{"point1":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument","entityScope":"InstrumentScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":100},"metaDataFields":{"currency":"USD"}},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00","valueFields":{"price":200},"metaDataFields":{"currency":"GBP"}},"point3":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"LegalEntity","entityScope":"LegalEntityScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"OtherValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":250},"metaDataFields":{"currency":"EUR"}}}},"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertRelationalDataPointRequest"}},"example":{"point1":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument","entityScope":"InstrumentScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":100},"metaDataFields":{"currency":"USD"}},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00","valueFields":{"price":200},"metaDataFields":{"currency":"GBP"}},"point3":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"LegalEntity","entityScope":"LegalEntityScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"OtherValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":250},"metaDataFields":{"currency":"EUR"}}}},"text/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertRelationalDataPointRequest"}},"example":{"point1":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument","entityScope":"InstrumentScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":100},"metaDataFields":{"currency":"USD"}},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00","valueFields":{"price":200},"metaDataFields":{"currency":"GBP"}},"point3":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"LegalEntity","entityScope":"LegalEntityScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"OtherValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":250},"metaDataFields":{"currency":"EUR"}}}},"application/*+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/UpsertRelationalDataPointRequest"}},"example":{"point1":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument","entityScope":"InstrumentScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":100},"metaDataFields":{"currency":"USD"}},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{"instrumentId":"SomeValue"}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00","valueFields":{"price":200},"metaDataFields":{"currency":"GBP"}},"point3":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"LegalEntity","entityScope":"LegalEntityScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":"OtherValue"}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":250},"metaDataFields":{"currency":"EUR"}}}}},"required":true},"responses":{"200":{"description":"The relational data points that were upserted.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchUpsertRelationalDatasetsResponse"},"example":{"values":{"point1":{"relationalDatasetDefinitionId":{"scope":"default","code":"sample-dataset"},"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument","entityScope":"InstrumentScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":{"value":"SomeValue"}}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":{"value":250}},"metaDataFields":{"currency":{"value":"USD"}},"effectiveAtEntered":"2019-01-01T12:00:00.0000000+00:00","dataPointVersion":{"asAtCreated":"2025-01-01T10:00:00.0000000+00:00","userIdCreated":"user-123","requestIdCreated":"request-123","asAtModified":"2025-01-02T11:00:00.0000000+00:00","userIdModified":"user-456","requestIdModified":"request-456","asAtVersionNumber":2,"entityUniqueId":"data-point-unique-id"}},"point2":{"relationalDatasetDefinitionId":{"scope":"default","code":"sample-dataset"},"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{"instrumentId":{"value":"SomeValue"}}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00","valueFields":{"price":{"value":300}},"metaDataFields":{"currency":{"value":"GBP"}},"effectiveAtEntered":"2019-01-02T12:00:00.0000000+00:00","dataPointVersion":{"asAtCreated":"2025-01-01T10:00:00.0000000+00:00","userIdCreated":"user-123","requestIdCreated":"request-123","asAtModified":"2025-01-02T12:00:00.0000000+00:00","userIdModified":"user-789","requestIdModified":"request-789","asAtVersionNumber":3,"entityUniqueId":"data-point-unique-id-2"}}},"failed":{"point3":{"id":"InvalidData","type":"The data point could not be upserted due to invalid data."}},"href":"http://example.com"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchUpsertRelationalDatasetsResponse"},"example":{"values":{"point1":{"relationalDatasetDefinitionId":{"scope":"default","code":"sample-dataset"},"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument","entityScope":"InstrumentScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":{"value":"SomeValue"}}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":{"value":250}},"metaDataFields":{"currency":{"value":"USD"}},"effectiveAtEntered":"2019-01-01T12:00:00.0000000+00:00","dataPointVersion":{"asAtCreated":"2025-01-01T10:00:00.0000000+00:00","userIdCreated":"user-123","requestIdCreated":"request-123","asAtModified":"2025-01-02T11:00:00.0000000+00:00","userIdModified":"user-456","requestIdModified":"request-456","asAtVersionNumber":2,"entityUniqueId":"data-point-unique-id"}},"point2":{"relationalDatasetDefinitionId":{"scope":"default","code":"sample-dataset"},"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{"instrumentId":{"value":"SomeValue"}}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00","valueFields":{"price":{"value":300}},"metaDataFields":{"currency":{"value":"GBP"}},"effectiveAtEntered":"2019-01-02T12:00:00.0000000+00:00","dataPointVersion":{"asAtCreated":"2025-01-01T10:00:00.0000000+00:00","userIdCreated":"user-123","requestIdCreated":"request-123","asAtModified":"2025-01-02T12:00:00.0000000+00:00","userIdModified":"user-789","requestIdModified":"request-789","asAtVersionNumber":3,"entityUniqueId":"data-point-unique-id-2"}}},"failed":{"point3":{"id":"InvalidData","type":"The data point could not be upserted due to invalid data."}},"href":"http://example.com"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchUpsertRelationalDatasetsResponse"},"example":{"values":{"point1":{"relationalDatasetDefinitionId":{"scope":"default","code":"sample-dataset"},"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument","entityScope":"InstrumentScope","identifierScope":"default","identifierType":"default","identifierValue":"IdentifierValue"},"seriesIdentifiers":{"instrumentId":{"value":"SomeValue"}}},"effectiveAt":"2019-01-01T12:00:00.0000000+00:00","valueFields":{"price":{"value":250}},"metaDataFields":{"currency":{"value":"USD"}},"effectiveAtEntered":"2019-01-01T12:00:00.0000000+00:00","dataPointVersion":{"asAtCreated":"2025-01-01T10:00:00.0000000+00:00","userIdCreated":"user-123","requestIdCreated":"request-123","asAtModified":"2025-01-02T11:00:00.0000000+00:00","userIdModified":"user-456","requestIdModified":"request-456","asAtVersionNumber":2,"entityUniqueId":"data-point-unique-id"}},"point2":{"relationalDatasetDefinitionId":{"scope":"default","code":"sample-dataset"},"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{"instrumentId":{"value":"SomeValue"}}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00","valueFields":{"price":{"value":300}},"metaDataFields":{"currency":{"value":"GBP"}},"effectiveAtEntered":"2019-01-02T12:00:00.0000000+00:00","dataPointVersion":{"asAtCreated":"2025-01-01T10:00:00.0000000+00:00","userIdCreated":"user-123","requestIdCreated":"request-123","asAtModified":"2025-01-02T12:00:00.0000000+00:00","userIdModified":"user-789","requestIdModified":"request-789","asAtVersionNumber":3,"entityUniqueId":"data-point-unique-id-2"}}},"failed":{"point3":{"id":"InvalidData","type":"The data point could not be upserted due to invalid data."}},"href":"http://example.com"}}}},"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":"Stable"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}