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
| Key | Datatype | Required | Description |
|---|---|---|---|
page[number] | number | A cursor to the page number for use in “pagination linked list” | |
page[size] | number | Numbers of items to return | |
filter[represents.data.id] | string | Only return items matching to represent.data.id | |
fallbackToSymbolsByGeometryEntityTypeHierarchy | string | Only 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 | |
sort | string | Sort by createdAt time |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"self":"/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20","first":"/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20","prev":"/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20","next":"/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20","last":"/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols?page[number]=1\u0026page[size]=20"},"data":[{"id":"827d0ae5-6c62-42a7-9367-7aa95512823e","meta":{"createdAt":"1945-05-13T01:43:28.593Z","updatedAt":"1986-11-19T18:23:18.867Z","createdBy":"Z0011111","updatedBy":"Z0011111"},"type":"Symbol","links":{"self":"/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols/4fa85f64-5454-1212-c3fc-2c963f66af44"},"relationships":{"isPartOfPalette":{"data":{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"represents":{"data":{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}},{"id":"827d0ae5-6c62-42a7-9367-7aa95512823e","meta":{"createdAt":"2005-06-12T21:12:27.790Z","updatedAt":"1945-12-21T09:12:03.241Z","createdBy":"Z0011111","updatedBy":"Z0011111"},"type":"Symbol","links":{"self":"/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/palettes/4fa85f64-8888-2222-c3fc-2c963f66afa6/symbols/4fa85f64-5454-1212-c3fc-2c963f66af44"},"relationships":{"isPartOfPalette":{"data":{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"represents":{"data":{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}}]}