RSK - API

Prints an overview of all API functions.

Method:

• GET

Returned document content type:

text/html

Retrieves the qualified names of all publicly available entitytypes in this API.

Method:

• GET

Returned document content type:

application/json

Retrieves information about the specified schema, which is publicly available.

Method:

• GET

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.

Returned document content type:

application/json

Retrieves information about the specified schema, according to user permissions.

Method:

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

Path variables:

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

Request parameters:

• String user (required)
  Username.
• String pass (required)
  Password.
• 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.

Returned document content type:

application/json

Retrieves information about the specified entitytype, which is publicly available.

Method:

• GET

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.

Returned document content type:

application/json

Retrieves information about the specified entitytype, according to user permissions.

Method:

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

Path variables:

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

Request parameters:

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

Returned document content type:

application/json

Retrieves information about the specified attribute, which is publicly available.

Method:

• GET

Path variables:

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

Request parameters:

• Boolean inclSubattributes (optional, default: false)
  Includes subattributes.

Returned document content type:

application/json

Retrieves information about the specified attribute, according to user permissions.

Method:

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

Path variables:

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

Request parameters:

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

Returned document content type:

application/json

Retrieves the universal resource identifiers of all entities of the specified type. The resource identifiers are mapped to the entities' internal numeric IDs.

Method:

• GET

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.

Returned document content type:

application/json

Retrieves all entities of the specified type.

Method:

• GET

Path variables:

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

Request parameters:

• 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 ids (optional)
  Include the entities with the specified numeric IDs, only. The value is a comma-separated list of IDs and ID ranges. Example: 3, 5, 7, 25-28, 84. If no IDs are specified, all entities are included.

Returned document content type:

application/json

Retrieves a specific entity for its type and numeric identifier.

Method:

• GET

Path variables:

• String type (required)
  Qualified entitytype name, e.g.: rsk:place.
• Integer id (required)
  Numeric entity identifier for entities of the specified type.

Request parameters:

• 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.

Returned document content type:

application/json

Retrieves a specific entity for its universal resource identifier.

Method:

• GET

Request parameters:

• String uri (required)
  The entity's resource URI.
• 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.

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.

Method:

• GET

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 ...].
• Integer maxResults (optional, default: 20)
  DEPRECATED: Use length!!!
• 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.

Returned document content type:

application/json

Retrieval endpoint for public media data.
The specified media ID is tracked back to its hosting attribute value and checked against its attribute's and entitytype's public flags.

Method:

• GET

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.

Method:

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

Path variables:

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

Request parameters:

• String user (required)
  Username.
• String pass (required)
  Password.
• JsonValue data (required)
  JSON import data.

Returned document content type:

application/json

DIKUSA TMD Export.

Method:

• GET

Returned document content type:

text/turtle

Special scenario 20251127 for rsk:corporate entities.

Method:

• GET

Path variables:

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

Returned document content type:

application/json