Resources

Alignments

Upload new alignment

POST /alignments
Parameters
Type Name Description Schema
Body conf
required		 Alignment configuration Alignment
Responses
HTTP Code Description Schema
201 Alignment uploaded successfully Response
208 Alignment already uploaded Response
400 Wrong arguments Error
409 Alignment with the same ID but different definition exists Error
Consumes
  • application/xml
Produces
  • application/json

List alignments

GET /alignments
Description

Lists alignments uploaded to the IPSM.

Responses
HTTP Code Description Schema
200 Available alignments info < AlignmentInfo > array

Get an alignment identified by name+version

GET /alignments/{name}/{version}
Parameters
Type Name Description Schema
Path name
required		 Name of the alignment to be retrieved string
Path version
required		 Version of the alignment to be retrieved string
Responses
HTTP Code Description Schema
200 Alignment successfuly returned No Content
400 Alignment not found Error
500 Alignment retrieval failed Error
Consumes
  • application/json
Produces
  • application/xml

Delete alignment identified by name+version

DELETE /alignments/{name}/{version}
Parameters
Type Name Description Schema
Path name
required		 Name of the alignment to delete string
Path version
required		 Version of the alignment to delete string
Responses
HTTP Code Description Schema
204 Alignment deleted No Content
400 Alignment not found Error
500 Alignment deletion failed Error

Convert XML alignment into RDF/XML format

POST /convert
Parameters
Type Name Description Schema
Body conf
required		 Alignment source string
Responses
HTTP Code Description Schema
201 Alignment converted successfully string
500 Alignment conversion failed Error
Consumes
  • application/xml
Produces
  • application/xml

Convert alignment cells to Turtle format

POST /convert/TTL
Parameters
Type Name Description Schema
Body conf
required		 Alignment source string
Responses
HTTP Code Description Schema
201 Alignment cells converted successfully string
500 Alignment cells conversion failed Error
Consumes
  • application/xml
Produces
  • application/xml

Channels

Create new channel

POST /channels
Parameters
Type Name Description Schema
Body conf
required		 Channel configuration ChannelConfig
Responses
HTTP Code Description Schema
201 Channel created successfully Response
400 Channel already exists or wrong arguments Error
Consumes
  • application/json
Produces
  • application/json

List active IPSM channels

GET /channels
Description

The endpoint returns the list of all IPSM channels which are currently active.

Responses
HTTP Code Description Schema
200 Array of channel information records < ChannelInfo > array

Delete channel based on the ID

DELETE /channels/{channelId}
Parameters
Type Name Description Schema
Path channelId
required		 ID of channel to delete integer
Responses
HTTP Code Description Schema
204 Channel deleted No Content
400 Channel not found Error
500 Closing channel failed Error

Logging

Get the current IPSM logging level

GET /logging
Responses
HTTP Code Description Schema
200 Current logging level successfuly returned LoggingResponse
Produces
  • application/json

Set logging level

POST /logging/{level}
Parameters
Type Name Description Schema
Path level
required		 Logging level enum (all, trace, debug, info, warn, error, off)
Responses
HTTP Code Description Schema
200 Logging level set successfully LoggingResponse
Produces
  • application/json

Translation

Translate JSON-LD message via sequence of alignments

POST /translation
Parameters
Type Name Description Schema
Body data
required		 Translation request data TranslationRequest
Responses
HTTP Code Description Schema
200 Translation successful TranslationResponse
400 Error during translation TranslationErrorResponse
Produces
  • application/json

Version

Get this IPSM version info

GET /version
Responses
HTTP Code Description Schema
200 IPSM version info successfuly returned VersionResponse
Produces
  • application/json