{"openapi":"3.0.4","info":{"title":"Query Relational Data Points for a given Relational Dataset Definition.","description":"Query 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}/$query":{"post":{"tags":["Relational Datasets"],"summary":"Query Relational Data Points for a given Relational Dataset Definition.","description":"Query Relational Data Points for a given Relational Dataset Definition.","operationId":"QueryRelationalData","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":"asAt","in":"query","description":"The asAt datetime at which to retrieve the dataset(s). Defaults to returning the latest version of each dataset if not specified.","schema":{"type":"string","format":"date-time"},"x-nullable":true},{"name":"effectiveAt","in":"query","description":"The effective datetime or cut label at which to query the datasets.\r\n            Defaults to the current LUSID system datetime if not specified.","schema":{"maxLength":256,"minLength":0,"pattern":"^[a-zA-Z0-9\\-_\\+:\\.]+$","type":"string","format":"dateorcutlabel"}},{"name":"page","in":"query","description":"The pagination token to use to continue query datasets. This value is returned from the previous call.\r\n            If a pagination token is provided, the filter, customSortBy, effectiveAt and asAt fields must not have changed since the original request.","schema":{"maxLength":500,"minLength":1,"pattern":"^[a-zA-Z0-9\\+/]*={0,3}$","type":"string"}},{"name":"limit","in":"query","description":"When paginating, limit the results to this number. Defaults to 100 if not specified.","schema":{"maximum":5000,"minimum":1,"type":"integer","format":"int32"},"x-nullable":true}],"requestBody":{"description":"The query request.","content":{"application/json-patch+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/QueryRelationalDatasetRequest"},"example":{"queryMethod":"Latest","filter":"","customSortBy":[]}},"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/QueryRelationalDatasetRequest"},"example":{"queryMethod":"Latest","filter":"","customSortBy":[]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/QueryRelationalDatasetRequest"},"example":{"queryMethod":"Latest","filter":"","customSortBy":[]}},"application/*+json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/QueryRelationalDatasetRequest"},"example":{"queryMethod":"Latest","filter":"","customSortBy":[]}}}},"responses":{"200":{"description":"The relational data points that were queried.","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/PagedResourceListOfRelationalDataPointResponse"},"example":{"values":[{"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"}},{"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"}}],"href":"http://example.com","links":[]}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/PagedResourceListOfRelationalDataPointResponse"},"example":{"values":[{"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"}},{"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"}}],"href":"http://example.com","links":[]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/PagedResourceListOfRelationalDataPointResponse"},"example":{"values":[{"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"}},{"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"}}],"href":"http://example.com","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":"Stable"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}