Retrieves a list with entity ID, CIDOC CRM code, system class, or view class. You can combine these endpoints in a single query.
Query parameters
Entity ids which will be requested
View classes to be requested
System classes to be requested
CIDOC classes to be requested
Entity IDs, from which all linked entities are requested
Download results
Show integer count of how many entities would the result give back
Will calculate the centerpoint for all polygons and linestrings and add them to geometries
Select which keys should not be displayed. This can improve performance
Choose the format for the results.
Export the entities into either a simple CSV representation or a zip file of CSV's especially designed for network analyses.
Choose one column to sort the results by. Default value is name.
Sorting result ascending or descending of the given column. Default value is asc.
Search query for specific results.
Filterable categories
entityName, entityDescription, entityAliases, entityCidocClass, entitySystemClass, entityID, typeID, valueTypeID, typeIDWithSubs, typeName, beginFrom, beginTo, endFrom, endTo, relationToID
Values
Values has to be a list of items. The items can be either a string, an integer or a tuple (see Notes). Strings need to be marked with “” or ‘’, while integers does not allow this.
Notes: The category valueTypeID can search for values of a type ID. But it takes one or more two valued Tuple as list entry: (x,y). x is the type id and y is the searched value. This can be an int or a float, e.g: {"operator":"lesserThan","values":[(3142,543.3)],"logicalOperator":"and"} The date categories (beginFrom, beginTo, endFrom, endTo) only allow one value in the values field and it has to be formated the following way: YYYY-MM-DD. Month and day values need to filled up with 0, e.g. 800-01-01
Compare operators
equal, notEqual, like (1), greaterThan (2), greaterThanEqual (2), lesserThan (2)
The compare operators work like the mathematical operators. equal x=y, notEqual x!=y, greaterThan x>y , greaterThanEqual x>=y, lesserThan x<y, lesserThanEqual x<=y. The like operator searches for occurrence of the string, so a match can also occur in the middle of a word.
(1)Only for string based categories
(2)Only for beginFrom, beginTo, endFrom, endTo, valueTypeID
Logical operators
Not mandatory, OR is the default value. Logical operators handles, if the values are treated as OR or AND.
The following table outlines the supported operations for each field:
| equal | notEqual | like | greaterThan | greaterThanEqual | lesserThan | lesserThanEqual | |
|---|---|---|---|---|---|---|---|
| entityName | x | x | x | ||||
| entityDescription | x | x | x | ||||
| entityAliases | x | x | x | ||||
| entityCidocClass | x | x | x | ||||
| entitySystemClass | x | x | x | ||||
| typeName | x | x | x | ||||
| entityID | x | x | |||||
| typeID | x | x | |||||
| valueTypeID | x | x | x | x | x | x | |
| typeIDWithSubs | x | x | |||||
| relationToID | x | x | |||||
| beginFrom | x | x | x | x | x | x | |
| beginTo | x | x | x | x | x | x | |
| endFrom | x | x | x | x | x | x | |
| endTo | x | x | x | x | x | x |
Begin results at the given entity id.
Begin results after the given entity id.
Jump to page number.
Limits the entities displayed. Influences the performance of the request. Default value is 20. 0 means all available entities will be displayed.
Show only entities with the given type id or linked to it.
Displays only connections connected by the selected CIDOC CRM property code. If geometry, types, depictions and/or links is in the show parameter, these properties are also displayed.
Choose language for system inherent labels
Response
Success