{"openapi":"3.0.4","info":{"title":"List Calendars","description":"List calendars at a point in AsAt time.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/calendars/generic":{"get":{"tags":["Calendars"],"summary":"List Calendars","description":"List calendars at a point in AsAt time.","operationId":"ListCalendars","parameters":[{"name":"asAt","in":"query","description":"The AsAt datetime at which to retrieve the calendars","schema":{"type":"string","format":"date-time"},"x-nullable":true},{"name":"page","in":"query","description":"The pagination token to use to continue listing calendars from a previous call to list calendars.\r\n            This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields\r\n            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 number of returned results to this many.","schema":{"maximum":5000,"minimum":1,"type":"integer","format":"int32"},"x-nullable":true},{"name":"propertyKeys","in":"query","description":"A list of property keys from the \"Calendar\" domain to decorate onto the calendar, \r\n            These take the format {domain}/{scope}/{code} e.g. \"Calendar/System/Name\".","schema":{"type":"array","items":{"type":"string","description":"The key that uniquely identifies the property. It has the format {domain}/{scope}/{code}."}},"x-nullable":true},{"name":"filter","in":"query","description":"Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.","schema":{"maxLength":16384,"minLength":0,"pattern":"^[\\s\\S]*$","type":"string"}}],"responses":{"200":{"description":"List Calendars","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/PagedResourceListOfCalendar"},"example":{"values":[{"href":"https://myco.lusid.com/api/api/calendar/testscope/testcode","id":{"scope":"TestScope","code":"TestCode"},"type":"Holiday","weekendMask":{"days":["Saturday","Sunday"],"timeZone":"UTC"},"sourceProvider":"Finbourne-Calendar-Service","properties":[{"key":"Calendar/HolidayType/Statutory","value":{"labelValue":"CBTR"}}],"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":"CalendarUser1","requestIdCreated":"CalendarRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CalendarUser2","requestIdModified":"CalendarRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}},{"href":"https://myco.lusid.com/api/api/calendar/testscope/testcode2","id":{"scope":"TestScope","code":"TestCode2"},"type":"Holiday","weekendMask":{"days":["Saturday","Sunday"],"timeZone":"UTC"},"sourceProvider":"Finbourne-Calendar-Service","properties":[{"key":"Calendar/HolidayType/Statutory","value":{"labelValue":"CBTR"}}],"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":"CalendarUser1","requestIdCreated":"CalendarRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CalendarUser2","requestIdModified":"CalendarRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}],"href":"https://myco.lusid.com/api/api/calendar/testscope","links":[]}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/PagedResourceListOfCalendar"},"example":{"values":[{"href":"https://myco.lusid.com/api/api/calendar/testscope/testcode","id":{"scope":"TestScope","code":"TestCode"},"type":"Holiday","weekendMask":{"days":["Saturday","Sunday"],"timeZone":"UTC"},"sourceProvider":"Finbourne-Calendar-Service","properties":[{"key":"Calendar/HolidayType/Statutory","value":{"labelValue":"CBTR"}}],"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":"CalendarUser1","requestIdCreated":"CalendarRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CalendarUser2","requestIdModified":"CalendarRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}},{"href":"https://myco.lusid.com/api/api/calendar/testscope/testcode2","id":{"scope":"TestScope","code":"TestCode2"},"type":"Holiday","weekendMask":{"days":["Saturday","Sunday"],"timeZone":"UTC"},"sourceProvider":"Finbourne-Calendar-Service","properties":[{"key":"Calendar/HolidayType/Statutory","value":{"labelValue":"CBTR"}}],"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":"CalendarUser1","requestIdCreated":"CalendarRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CalendarUser2","requestIdModified":"CalendarRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}],"href":"https://myco.lusid.com/api/api/calendar/testscope","links":[]}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/PagedResourceListOfCalendar"},"example":{"values":[{"href":"https://myco.lusid.com/api/api/calendar/testscope/testcode","id":{"scope":"TestScope","code":"TestCode"},"type":"Holiday","weekendMask":{"days":["Saturday","Sunday"],"timeZone":"UTC"},"sourceProvider":"Finbourne-Calendar-Service","properties":[{"key":"Calendar/HolidayType/Statutory","value":{"labelValue":"CBTR"}}],"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":"CalendarUser1","requestIdCreated":"CalendarRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CalendarUser2","requestIdModified":"CalendarRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}},{"href":"https://myco.lusid.com/api/api/calendar/testscope/testcode2","id":{"scope":"TestScope","code":"TestCode2"},"type":"Holiday","weekendMask":{"days":["Saturday","Sunday"],"timeZone":"UTC"},"sourceProvider":"Finbourne-Calendar-Service","properties":[{"key":"Calendar/HolidayType/Statutory","value":{"labelValue":"CBTR"}}],"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":"CalendarUser1","requestIdCreated":"CalendarRequestId1","reasonCreated":"","asAtModified":"2018-03-08T10:10:10.0000000+00:00","userIdModified":"CalendarUser2","requestIdModified":"CalendarRequestId2","reasonModified":"","asAtVersionNumber":2,"entityUniqueId":"67cd5403-60d3-4744-8455-c4522a3886cb"}}],"href":"https://myco.lusid.com/api/api/calendar/testscope","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":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}