Definitions

Alignment

Name	Description	Schema
creator optional	Alignment creator	string
description optional	Alignment description	string
map required	map	map
name required	Alignment name	string
onto1 required	onto1	onto1
onto2 required	onto2	onto2
steps required	Steps	steps
version required	Alignment version	string

map

Name	Description	Schema
Cell optional	Cell	Cell

Cell

Name	Description	Schema
entity1 required	The first aligned ontology entity	object
entity2 required	The second aligned ontology entity	object
relation required	Relation	string

onto1

Name	Description	Schema
Ontology required	Contains the URI identifying the ontology	Ontology

Ontology

Name	Description	Schema
about optional	URI identifying the ontology	string

onto2

Name	Description	Schema
Ontology optional	Contains the URI identifying the ontology	Ontology

Ontology

Name	Description	Schema
about optional	URI identifying the ontology	string

steps

Name	Description	Schema
step optional	Alignment step	step

step

Name	Description	Schema
cell optional	Alignment cell ID	string
order optional	Order of cell application	integer

AlignmentID

Name	Description	Schema
name required	Alignment name	string
version required	Alignment version	string

AlignmentInfo

Name	Description	Schema
creator required	Alignment creator	string
date required	UNIX timestamp of upload to IPSM	integer
descId required	Business identifier	string
description required	Alignment description	string
id required	Technical identifier	integer
name required	Name of the alignment	string
sourceOntologyURI required	URI of the source ontology for alignment	string
targetOntologyURI required	URI of the target ontology for alignment	string
version required	Alignment version	string

ChannelConfig

Name	Description	Schema
inpAlignmentName required	Name of the input alignment, used for translating the incoming RDF data	string
inpAlignmentVersion required	Version of the input alignment, used for translating the incoming RDF data	string
outAlignmentName required	Name of the output alignment, used for translating the outgoing RDF data	string
outAlignmentVersion required	Version of the output alignment, used for translating the outgoing RDF data	string
parallelism optional	Internal parallelism of the channel, e.g., the value 5 means that the channel can consume 5 messages in parallel (preserving their time order)	integer
sink required	Identifier of the sink of the channel, i.e., Apache Kafka topic to which IPSM publishes translated RDF data	string
source required	Identifier representing the source of the channel, i.e. Apache Kafka topicfrom which IPSM reads the RDF data to be translated	string

ChannelInfo

Name	Description	Schema
descId required	Business identifier of the channel	string
id required	Identifier of the channel	integer
inpAlignmentName required	Name of the input alignment, used for translating the incoming RDF data	string
inpAlignmentVersion required	Version of the input alignment, used for translating the incoming RDF data	string
outAlignmentName required	Name of the output alignment, used for translating the outgoing RDF data	string
outAlignmentVersion required	Version of the output alignment, used for translating the outgoing RDF data	string
sink required	Identifier of the sink of the channel, i.e. Apache Kafka topic to which IPSM publishes translated RDF data	string
source required	Identifier representing the source of the channel, i.e. Apache Kafka topic from which IPSM reads the RDF data to be translated	string

Error

Name	Schema
message required	string

LoggingResponse

Name	Schema
level required	enum (ALL, TRACE, DEBUG, INFO, WARN, ERROR, OFF)
message required	string

Response

Name	Description	Schema
message required	Descriptive response	string

TranslationErrorResponse

Name	Description	Schema
graphStr required	Empty string Maximal length : 0	string
message required	Info on the failure of the translation	string

TranslationRequest

Name	Description	Schema
alignIDs required	Sequence of alignment IDs to ba applied	< AlignmentID > array
graphStr required	JSON-LD message as a string	string

TranslationResponse

Name	Description	Schema
graphStr required	Translated JSON-LD message as a string	string
message required	Info on the success of the translation	string

VersionResponse

Name	Description	Schema
name required	Named of IPSM instance	string
version required	Version of IPSM instance	string