here.platform.schema_api module

HERE platform Schema abstraction.

class here.platform.schema_api.Schema(hrn: str, configuration: SchemaConfiguration, platform: Platform)
Bases: object

HERE platform Schema abstraction.

get_document(filename) → str

Return the url to schema documentation.

Parameters:
filename – The path to schema file.

Returns:
response from the API.

update_permission(body: dict) → bool

Grant/revoke permissions for schema. READ grants ‘readResource’, MODIFY grants ‘modifyResource’, SHARE grants ‘shareResource’.

Parameters:
body – a dictionary with permissions.

Returns:
response from the API.

class here.platform.schema_api.SchemaConfiguration(json_dict: Dict[str, Any])
Bases: JsonDictDocument

A JSON document for schema configuration used in APIs loaded into a Dict.

property artifact_id: str | None
Artifact ID in the schema response

property created: str | None
Created date in the schema response

property group_id: str | None
Group ID in the schema response

property name: str | None
Name in the schema response

property summary: str | None
Summary in the schema response

property type: str | None
Type in the schema response

property updated: str | None
Updated date in the schema response

property version: str | None
Version in the schema response