Get system_classsystem_class — openatlas-api

v54

latestOpenAPI 3.0.2GPL-2.0raw.githubusercontent.com2026-08-023358233.3 KB

Entities Endpoint

Retrieves entities based on their OpenAtlas class name.

get/system_class/{system_class}

Path parameters

Example:acquisition

System class to be requested

Query parameters

downloadboolean

Download results

countboolean

Show integer count of how many entities would the result give back

showstring[]

Select which keys should not be displayed. This can improve performance

Example:lpx

Specify the format for the returned results.

export'csv' | 'csvNetwork'

Example:csv

Export the entities in either a simple CSV format or a ZIP file containing CSV files optimized for network analysis.

Choose one column to sort the results by. Default value is name.

sort'asc' | 'desc'

Example:desc

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           |

{
  "entityName": [
    {
      "operator": "like",
      "values": [
        "A"
      ],
      "logicalOperator": "and"
    }
  ]
}

firstinteger

Starts the result set at the specified entity ID.

lastinteger

Starts the result set after the specified entity ID.

pageinteger

Example:3

Specifies the page number to retrieve in a paginated result set.

limitinteger

Limits the number of entities returned in the response. A lower value may improve performance. The default is 20. Set to 0 to return all available entities.

type_idinteger[]

Filter results to include only entities with the specified type ID or those linked to it.

relation_typestring[]

Filters results to show only connections linked by the selected CIDOC CRM property code. If 'geometry', 'types', 'depictions', or 'links' are specified in the 'show' parameter, these properties will also be displayed.

locale'ca' | 'de' | 'en' | 'es' | 'fr'

Example:de

Choose language for system inherent labels

centroidboolean

Will calculate the centerpoint for all polygons and linestring and add them to geometries

Response

Success