Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -28,8 +28,9 @@
28	28
29	29	Simply use the API endpoint at [[https:~~/~~/spatial.kg.ebrains.eu/api/>>https://spatial.kg.ebrains.eu/api/]] by running queries according to the following examples:
30	30
31		-== Get started: Query by a "bounding box" (hyperrectangle) ==
32	32
	32	+==== Get started: Query by a "bounding box" (hyperrectangle) ====
	33	+
33	33	{{code language="bash" layout="LINENUMBERS"}}
34	34	curl -X 'POST' \
35	35	'https://spatial.kg.ebrains.eu/spatial-search/cores/ebrains/spatial_objects' \
...	...	@@ -42,8 +42,9 @@
42	42
43	43	As you can see, you're sending a POST request to the endpoint at **https:~/~/spatial.kg.ebrains.eu/spatial-search/cores/ebrains/spatial_objects  **with a payload defining a geometry of interest. In this case, we're looking for all objects that are **inside **a **hyperrectangle **defined by its lowest and highest point in the coordinate system of the coordinate space **AMB-CCF_v3-RAS**. This query will return you an array of ids of the objects located within the geometry which you then can use to conveniently query the KG either through the [[Instance API>>https://core.kg.ebrains.eu/swagger-ui/index.html#/2%20Advanced/getInstancesByIds]] or the [[Query API>>https://core.kg.ebrains.eu/swagger-ui/index.html#/1%20Basic/runDynamicQuery]] to access detailed meta information.
44	44
45		-== Query by hypersphere ==
46	46
	47	+==== Query by hypersphere ====
	48	+
47	47	Alongside the possibility to use hyperrectangles for querying the spatial search, you can also use hyperspheres:
48	48
49	49	{{code language="javascript" layout="LINENUMBERS"}}
...	...	@@ -54,8 +54,10 @@
54	54
55	55	It is defined by the center of the sphere with its coordinates, the radius in coordinate units and the coordinate space of the given coordinates (in this case again AMB-CCF_v3-RAS)
56	56
57		-== Advanced use: Union geometries for complex queries ==
58	58
	60	+
	61	+==== Advanced use: Union geometries for complex queries ====
	62	+
59	59	To build arbitrarily complex geometries, it is possible to combine hyperrectangles and hyperspheres via (nested) unions:
60	60
61	61	{{code language="javascript" layout="LINENUMBERS"}}