List Symbols

GET {{baseUrl}}/palettes/:paletteId/symbols?page[number]=1&page[size]=20&filter[represents.data.id]=<string>&fallbackToSymbolsByGeometryEntityTypeHierarchy=<boolean>&sort=-createdAt

List Symbols, filtered by user provided parameters

Request Params

KeyDatatypeRequiredDescription
page[number]numberA cursor to the page number for use in “pagination linked list”
page[size]numberNumbers of items to return
filter[represents.data.id]stringOnly return items matching to represent.data.id
fallbackToSymbolsByGeometryEntityTypeHierarchystringOnly applicable when filter[represents.data.id] is provided. If true, the Present Symbol provided if child symbol not created. Else empty result set will be returned. The root element will be GeometryEntityType=unknown
sortstringSort by createdAt time

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;links&quot;:{&quot;self&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20&quot;,&quot;first&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20&quot;,&quot;prev&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20&quot;,&quot;next&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20&quot;,&quot;last&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20&quot;},&quot;data&quot;:[{&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;,&quot;meta&quot;:{&quot;createdAt&quot;:&quot;1945-05-13T01:43:28.593Z&quot;,&quot;updatedAt&quot;:&quot;1986-11-19T18:23:18.867Z&quot;,&quot;createdBy&quot;:&quot;Z0011111&quot;,&quot;updatedBy&quot;:&quot;Z0011111&quot;},&quot;type&quot;:&quot;Symbol&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols/4fa85f64-5454-1212-c3fc-2c963f66af44&quot;},&quot;relationships&quot;:{&quot;isPartOfPalette&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},&quot;represents&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}}},{&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;,&quot;meta&quot;:{&quot;createdAt&quot;:&quot;2005-06-12T21:12:27.790Z&quot;,&quot;updatedAt&quot;:&quot;1945-12-21T09:12:03.241Z&quot;,&quot;createdBy&quot;:&quot;Z0011111&quot;,&quot;updatedBy&quot;:&quot;Z0011111&quot;},&quot;type&quot;:&quot;Symbol&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols/4fa85f64-5454-1212-c3fc-2c963f66af44&quot;},&quot;relationships&quot;:{&quot;isPartOfPalette&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},&quot;represents&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}}}]}