Sign in
Entities Endpoint

Retrieves entities based on their CIDOC CRM class code.

get/cidoc_class/{cidoc_class}

Path parameters

cidoc_class'all' | 'E5' | 'E7' | 'E8' | 'E9' | 'E12' | 'E18' | 'E20' | 'E21' | 'E22' | 'E31' | 'E32' | 'E33' | 'E41' | 'E53' | 'E54' | 'E55' | 'E65' | 'E74' required
Example:E18

CIDOC 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

format'lp' | 'lpx' | 'loud' | 'geojson' | 'geojson-v2' | 'gpkg' | 'table_row' | 'pretty-xml' | 'n3' | 'turtle' | 'nt' | 'xml'
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.

column'id' | 'name' | 'cidoc_class' | 'system_class' | 'type' | 'class' | 'created' | 'creator' | 'content' | 'count' | 'description' | 'extension' | 'icon' | 'group' | 'license_holder' | 'license' | 'public' | 'size' | 'begin_from' | 'begin_to' | 'end_from' | 'end_to' | 'end' | 'begin' | 'checkbox'

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

Changes

Changed in 16 of the 54 revisions of this API.52149

  • f1cfc7b7cc701See the full diff
    • ○

      for the path request parameter cidoc_class, the type/format was generalized from / to string/

      request-parameter-type-generalized

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 782890032b511See the full diff
    • ○

      added the new enum value gpkg to the query request parameter format

      request-parameter-enum-value-added

  • 4021f2c1f3331See the full diff
    • ○

      added the optional property results/items/oneOf[LinkedPlacesModel]/features/items/depictions/items/mainImage to the response with the 200 status

      response-optional-property-added

  • edaf3e95085d1See the full diff
    • ○

      added the new enum value loud to the query request parameter format

      request-parameter-enum-value-added

  • 008688998b8320See the full diff
    • ▲

      the response property results/items/oneOf[GeoJSONModel]/ became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/oneOf[LinkedPlacesModel]/features/items/descriptions became nullable for the status 200

      response-property-became-nullable

    • ▲

      the allOf[ApiError]/url response's property type/format changed from string/uri to string/ for status 401

      response-property-type-changed

    • ▲

      the allOf[ApiError]/url response's property type/format changed from string/uri to string/ for status 403

      response-property-type-changed

    • ▲

      the allOf[ApiError]/url response's property type/format changed from string/uri to string/ for status 404

      response-property-type-changed

    • ▲

      the allOf[ApiError]/url response's property type/format changed from string/uri to string/ for status 409

      response-property-type-changed

    • ▲

      the allOf[ApiError]/url response's property type/format changed from string/uri to string/ for status 500

      response-property-type-changed

    • ▲

      the anyOf[ApiError]/url response's property type/format changed from string/uri to string/ for status 400

      response-property-type-changed

    • ▲

      the results/items/oneOf[GeoJSONModel]/features/items/geometry/oneOf[GeometryCollection]/geometries/items/anyOf[LineString]/coordinates/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[GeoJSONModel]/features/items/geometry/oneOf[GeometryCollection]/geometries/items/anyOf[Point]/coordinates/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[GeoJSONModel]/features/items/geometry/oneOf[GeometryCollection]/geometries/items/anyOf[Polygon]/coordinates/items/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[GeoJSONModel]/features/items/geometry/oneOf[LineString]/coordinates/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[GeoJSONModel]/features/items/geometry/oneOf[Point]/coordinates/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[GeoJSONModel]/features/items/geometry/oneOf[Polygon]/coordinates/items/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[LinkedPlacesModel]/features/items/geometry/oneOf[GeometryCollection]/geometries/items/anyOf[LineString]/coordinates/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[LinkedPlacesModel]/features/items/geometry/oneOf[GeometryCollection]/geometries/items/anyOf[Point]/coordinates/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[LinkedPlacesModel]/features/items/geometry/oneOf[GeometryCollection]/geometries/items/anyOf[Polygon]/coordinates/items/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[LinkedPlacesModel]/features/items/geometry/oneOf[LineString]/coordinates/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[LinkedPlacesModel]/features/items/geometry/oneOf[Point]/coordinates/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the results/items/oneOf[LinkedPlacesModel]/features/items/geometry/oneOf[Polygon]/coordinates/items/items/items/ response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

  • 26f86ddcd57c9See the full diff
    • ○

      added ApiError subschema #2 to the response body allOf list for the response status 404

      response-body-all-of-added

    • ○

      added ApiError ParameterError subschema #3 to the response body anyOf list for the response status 400

      response-body-any-of-added

    • ○

      removed ErrorModel ParameterErrorModel from the response body oneOf list for the response status 400

      response-body-one-of-removed

    • ○

      removed ErrorModel ParameterErrorModel from the response body oneOf list for the response status 404

      response-body-one-of-removed

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      removed the non-success response with the status 405

      response-non-success-status-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 676032e96b3f29See the full diff
    • ▲

      media type application/ld+json was changed to a more general media type application/json for the response status 200

      response-media-type-name-generalized

    • ▲

      added LinkedArtModel TableRowModel to the results/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      added the media type application/rdf+xml for the response with the status 200

      response-media-type-added

    • ○

      added the media type application/xml for the response with the status 200

      response-media-type-added

    • ○

      added the media type text/csv for the response with the status 200

      response-media-type-added

    • ○

      added the media type text/plain for the response with the status 200

      response-media-type-added

    • ○

      added the media type text/rdf+n3 for the response with the status 200

      response-media-type-added

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 405

      response-non-success-status-added

    • ○

      removed SearchModel from the results/items/ response property oneOf list for the response status 200

      response-property-one-of-removed

  • f6bbad448a9f1See the full diff
    • ○

      added the new enum value checkbox to the query request parameter column

      request-parameter-enum-value-added

  • ce0e102b135c2See the full diff
    • ○

      added the new enum value begin to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value end to the query request parameter column

      request-parameter-enum-value-added

  • 071c35a915c514See the full diff
    • ○

      added the new enum value class to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value content to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value count to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value created to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value creator to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value description to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value extension to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value group to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value icon to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value license to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value license_holder to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value public to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value size to the query request parameter column

      request-parameter-enum-value-added

    • ○

      added the new enum value type to the query request parameter column

      request-parameter-enum-value-added