{"openapi":"3.0.4","info":{"title":"Batch Delete Relational Data Points for a given Relational Dataset Definition.","description":"Batch Delete 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}/$batchDelete":{"post":{"tags":["Relational Datasets"],"summary":"Batch Delete Relational Data Points for a given Relational Dataset Definition.","description":"Batch Delete Relational Data Points for a given Relational Dataset Definition.","operationId":"BatchDeleteRelationalData","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 Delete Request.","content":{"application/json-patch+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/DeleteRelationalDataPointRequest"}},"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"},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00"}}},"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/DeleteRelationalDataPointRequest"}},"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"},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00"}}},"text/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/DeleteRelationalDataPointRequest"}},"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"},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00"}}},"application/*+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/DeleteRelationalDataPointRequest"}},"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"},"point2":{"dataSeries":{"seriesScope":"SeriesScope","applicableEntity":{"entityType":"Instrument"},"seriesIdentifiers":{}},"effectiveAt":"2019-01-02T12:00:00.0000000+00:00"}}}},"required":true},"responses":{"200":{"description":"The deleted DataPoint metadata.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchDeleteRelationalDataResponse"},"example":{"values":{"point1":"2025-01-01T12:00:00.0000000+00:00"},"failed":{"point2":{"id":"NotFound","type":"The data point could not be found for deletion."}},"href":"http://example.com"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchDeleteRelationalDataResponse"},"example":{"values":{"point1":"2025-01-01T12:00:00.0000000+00:00"},"failed":{"point2":{"id":"NotFound","type":"The data point could not be found for deletion."}},"href":"http://example.com"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchDeleteRelationalDataResponse"},"example":{"values":{"point1":"2025-01-01T12:00:00.0000000+00:00"},"failed":{"point2":{"id":"NotFound","type":"The data point could not be found for deletion."}},"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"}}}}