RSK - API

Prints an overview of all API functions.

Methods:

• GET

  Authentication is neither necessary nor possible.

Returned document content type:

text/html

Retrieves information about all schemas.
In case of GET request, only publicly available schemas and information is returned.
In case of POST request, information is returned according to user permissions.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Request parameters:

• Boolean inclSubschemas (optional, default: false)
  Includes subschemas.
• Boolean inclEntitytypes (optional, default: false)
  Includes entitytypes.
• Boolean inclAttributes (optional, default: false)
  Includes attributes.
• Boolean inclSubattributes (optional, default: false)
  Includes subattributes.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves information about the specified schema.
In case of GET request, only publicly available information is returned.
In case of POST request, information is returned according to user permissions.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String schema (required)
  Qualified schema name, e.g.: rsk.vocab.

Request parameters:

• Boolean inclSubschemas (optional, default: false)
  Includes subschemas.
• Boolean inclEntitytypes (optional, default: false)
  Includes entitytypes.
• Boolean inclAttributes (optional, default: false)
  Includes attributes.
• Boolean inclSubattributes (optional, default: false)
  Includes subattributes.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves information about all entitytypes.
In case of GET request, only publicly available entitytypes and information is returned.
In case of POST request, information is returned according to user permissions.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Request parameters:

• Boolean inclAttributes (optional, default: false)
  Includes attributes.
• Boolean inclSubattributes (optional, default: false)
  Includes subattributes.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves information about the specified entitytype.
In case of GET request, only publicly available information is returned.
In case of POST request, information is returned according to user permissions.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Qualified entitytype name, e.g.: rsk:place.

Request parameters:

• Boolean inclAttributes (optional, default: false)
  Includes attributes.
• Boolean inclSubattributes (optional, default: false)
  Includes subattributes.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves information about the specified attribute.
In case of GET request, only publicly available information is returned.
In case of POST request, information is returned according to user permissions.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String attr (required)
  Qualified attribute name, e.g.: rsk:place:name.

Request parameters:

• Boolean inclSubattributes (optional, default: false)
  Includes subattributes.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves the universal resource identifiers of all entities of the specified type.
The result set is subject to permission-based filtering, so there is no guaranty that this operation yields all URIs.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Qualified entitytype name, e.g.: rsk:place.

Request parameters:

• Boolean alias (optional, default: false)
  Instead of returning an array with URIs only, return a JSON object with URIs as keys, mapping to arrays of their corresponding aliases.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves all entities of the specified type.
The result set is subject to permission-based filtering, so there is no guaranty that this operation yields all entities.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Qualified entitytype name, e.g.: rsk:place.

Request parameters:

• String ids (optional)
  Include the entities with the specified numeric IDs and aliases, only.
  The value is a comma-separated list of individual IDs and numeric aliases, ranges of IDs and numeric aliases, and individual non-numeric aliases.
  Non-numeric aliases must be quoted.
  If ids is not specified, all entities are included.
  The string representation of this list is comma-separated and pretty-print whitespace is allowed.
  Example 1: 3, 5, 7, 25-28, 84
  Example 2: 3, 5, "Deutschland", 7
• Boolean refs (optional, default: false)
  Include referencing entities.
  For that purpose all entities returned will have an additional mapping refs containing an array with the referencing entities. That array may be empty.
• String proj (optional)
  The attributes projection is a comma-separated sequence of directives, which include or exclude attributes or subattributes.
  • Attributes to be included are specified by numeric ID or qualified name relative to the entitytype.
  • Prepend with "-" to exclude an attribute.
  • The directives are evaluated sequentially, i.e. directives specified later override those specified earlier.
  The following algorithm decides which attributes are projected eventually:
  1. If there is no directive, all attributes and subattributes are included.
  2. If the first directive is an inclusion, all attributes and subattributes are excluded before implicitly.
  3. Attribute directives void earlier directives on attribute and subattributes.
  4. Attribute inclusion implies all subattributes' inclusion.
  5. Attribute exclusion implies all subattributes' exclusion.
  6. Subattribute inclusion implies attribute's inclusion.
  7. Subattribute exclusion implies attribute's exclusion, iff it is empty.
  Example 1: firstname, lastname, event, -event.info
  Example 2: -images, -event, event.date
  If not specified, all attributes and subattributes are projected.
• String sort (optional, default: id ASC)
  Sort order for listed entities.
  Example: firstname DESC NULLS LAST, lastname ASC, id DESC.
  If no sort order is specified, the default order id ASC is applied.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves a single entity by its type and numeric identifier.
The result is subject to permission-based filtering, so there is no guaranty that this operation yields that entity.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Qualified entitytype name, e.g.: rsk:place.
• String id (required)
  Numeric entity ID or alias.
  (Entity aliases must not be quoted here!)
  Example 1: 7
  Example 2: Deutschland

Request parameters:

• Boolean refs (optional, default: false)
  Include referencing entities.
  For that purpose all entities returned will have an additional mapping refs containing an array with the referencing entities. That array may be empty.
• String proj (optional)
  The attributes projection is a comma-separated sequence of directives, which include or exclude attributes or subattributes.
  • Attributes to be included are specified by numeric ID or qualified name relative to the entitytype.
  • Prepend with "-" to exclude an attribute.
  • The directives are evaluated sequentially, i.e. directives specified later override those specified earlier.
  The following algorithm decides which attributes are projected eventually:
  1. If there is no directive, all attributes and subattributes are included.
  2. If the first directive is an inclusion, all attributes and subattributes are excluded before implicitly.
  3. Attribute directives void earlier directives on attribute and subattributes.
  4. Attribute inclusion implies all subattributes' inclusion.
  5. Attribute exclusion implies all subattributes' exclusion.
  6. Subattribute inclusion implies attribute's inclusion.
  7. Subattribute exclusion implies attribute's exclusion, iff it is empty.
  Example 1: firstname, lastname, event, -event.info
  Example 2: -images, -event, event.date
  If not specified, all attributes and subattributes are projected.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieves a single entity by its universal resource identifier.
As an entity may have aliases assigned to it, it is possible to access an entity by multiple URIs.
The result is subject to permission-based filtering, so there is no guaranty that this operation yields that entity.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Request parameters:

• String uri (required)
  The entity's resource URI.
• Boolean refs (optional, default: false)
  Include referencing entities.
  For that purpose all entities returned will have an additional mapping refs containing an array with the referencing entities. That array may be empty.
• String proj (optional)
  The attributes projection is a comma-separated sequence of directives, which include or exclude attributes or subattributes.
  • Attributes to be included are specified by numeric ID or qualified name relative to the entitytype.
  • Prepend with "-" to exclude an attribute.
  • The directives are evaluated sequentially, i.e. directives specified later override those specified earlier.
  The following algorithm decides which attributes are projected eventually:
  1. If there is no directive, all attributes and subattributes are included.
  2. If the first directive is an inclusion, all attributes and subattributes are excluded before implicitly.
  3. Attribute directives void earlier directives on attribute and subattributes.
  4. Attribute inclusion implies all subattributes' inclusion.
  5. Attribute exclusion implies all subattributes' exclusion.
  6. Subattribute inclusion implies attribute's inclusion.
  7. Subattribute exclusion implies attribute's exclusion, iff it is empty.
  Example 1: firstname, lastname, event, -event.info
  Example 2: -images, -event, event.date
  If not specified, all attributes and subattributes are projected.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Fulltext search for entities of the specified type.
The output is ranked by match precision, which favors full matches as well as identifiers over aliases and aliases over attribute values.
The ranking score value is attached to the entities' JSON objects.

Methods:

• GET

  Authentication is neither necessary nor possible.

  POST

  Authentication is optional.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Qualified entitytype name, e.g.: rsk:place.

Request parameters:

• String expr (required)
  Search terms.
• Boolean matchIdent (optional, default: true)
  Match search terms against numeric entity IDs.
  This option applies to purely numeric search terms, only.
• Boolean matchAlias (optional, default: true)
  Match search terms against entity alias texts.
• String matchAttrs (optional, default: true)
  Match search terms against fulltext-search-enabled top-level attributes.
  Use true to match against all attributes (default).
  Use false to not match against attributes altogether.
  Specify a comma-separated list of top-level attributes to define attribute inclusions an exclusions.
  Attributes may be specified as IDs or local names.
  Prepend "-" to exclude attribute.
  If first attribute is excluded, the attributes start out fully populated.
• Boolean caseSensitive (optional, default: false)
  Case sensitive search.
• Boolean diacSensitive (optional, default: false)
  Diacritics sensitive search.
• Integer termLength (optional, default: 1)
  Minimum length of individual search terms. Terms shorter than that will be ignored.
  Valid range: [1 ...].
• Integer offset (optional, default: 0)
  Results offset for block-by-block search results retrieval.
  Valid range: [0 ...].
• Integer length (optional, default: 20)
  Results length for block-by-block search results retrieval.
  0 = unlimited
  Valid range: [0 ...].
• Boolean refs (optional, default: false)
  Include referencing entities.
  For that purpose all entities returned will have an additional mapping refs containing an array with the referencing entities. That array may be empty.
• String proj (optional)
  The attributes projection is a comma-separated sequence of directives, which include or exclude attributes or subattributes.
  • Attributes to be included are specified by numeric ID or qualified name relative to the entitytype.
  • Prepend with "-" to exclude an attribute.
  • The directives are evaluated sequentially, i.e. directives specified later override those specified earlier.
  The following algorithm decides which attributes are projected eventually:
  1. If there is no directive, all attributes and subattributes are included.
  2. If the first directive is an inclusion, all attributes and subattributes are excluded before implicitly.
  3. Attribute directives void earlier directives on attribute and subattributes.
  4. Attribute inclusion implies all subattributes' inclusion.
  5. Attribute exclusion implies all subattributes' exclusion.
  6. Subattribute inclusion implies attribute's inclusion.
  7. Subattribute exclusion implies attribute's exclusion, iff it is empty.
  Example 1: firstname, lastname, event, -event.info
  Example 2: -images, -event, event.date
  If not specified, all attributes and subattributes are projected.
• String user (GETnot allowed, POSToptional)
  Username.
• String pass (GETnot allowed, POSToptional)
  Password.

Returned document content type:

application/json

Retrieval endpoint for public media data.
The specified media ID is tracked back to its hosting attribute value, which is checked for READ access for the attribute and entity.

Methods:

• GET

  Authentication is neither necessary nor possible.

Path variables:

• Integer id (required)
  Media object ID.

Request parameters:

• String imageRes (optional, default: MASTER)
  Resolution parameter for image media resources, only.
  

  MASTER	Master image: unscaled (default).
  THUMB	Thumbnail image, downscaled to 120k (e.g.: 400x300 @4:3).
  SC_500K	Downscaled image (e.g.: 800x600 @4:3).
  SC_1M	Downscaled image (e.g.: 1280x720 @16:9).
  SC_2M	Downscaled image (e.g.: 1920x1080 @16:9).

Returned document content type:

application/octet-stream

Import of entities of the specified type.

Methods:

• POST

  Authentication is mandatory.
  Request parameters must be sent via POST body,
  using MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Qualified entitytype name, e.g.: rsk:place.

Request parameters:

• JsonValue data (required)
  JSON import data.
  For information about the import format, take a look into the import manual in the webapp.
• String user (required)
  Username.
• String pass (required)
  Password.

Returned document content type:

application/json

DIKUSA TMD Export.

Methods:

• GET

  Authentication is neither necessary nor possible.

Returned document content type:

text/turtle

Special scenario 20251127 for rsk:corporate entities.

Methods:

• GET

  Authentication is neither necessary nor possible.

Path variables:

• Integer level (required)
  Presentation level: 0 = nothing, 1 = SKA, 2 = SSG, 3+ = World.

Returned document content type:

application/json