8. API Reference¶

8.1. API Overview¶

Resource	Operation	Description
Applications	POST /applications	Create a new Application.
	GET /applications	List all the Applications instantiated.
	DELETE /applications/(a)	Delete an Application.
DataReaders	POST /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers	Create a new DataReader.
	GET /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers	List all the DataReaders within a Subscriber.
	PUT /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers/(dr)	Enable a DataReader.
	GET /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers/(dr)	Read data.
	DELETE /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers/(dr)	Delete a DataReader.
DataWriters	POST /applications/(a)/domain_participants/(dp)/publishers/(p)/data_writers	Create a new DataWriter.
	GET /applications/(a)/domain_participants/(dp)/publishers/(p)/data_writers	List all the DataWriters within a Publisher.
	PUT /applications/(a)/domain_participants/(dp)/publishers/(s)/data_writers/(dw)	Enable a DataWriter.
	POST /applications/(a)/domain_participants/(dp)/publishers/(s)/data_writers/(dw)	Write a data sample.
	DELETE /applications/(a)/domain_participants/(dp)/publishers/(s)/data_writers/(dw)	Delete a DataWriter.
Domain Libraries	POST /domain_libraries	Create a new Domain Library.
	GET /domain_libraries	List all the available Domain Libraries.
	DELETE /domain_libraries/(dl)	Delete a Domain Library.
DomainParticipants	POST /applications/(a)/domain_participants	Create a new DomainParticipant.
	GET /applications/(a)/domain_participants	List all the DomainParticipants within an Application.
	PUT /applications/(a)/domain_participants/(dp)	Enable a DomainParticipant.
	DELETE /applications/(a)/domain_participants/(dp)	Delete a DomainParticipant.
Publishers	POST /applications/(a)/domain_participants/(dp)/publishers	Create a new Publisher.
	GET /applications/(a)/domain_participants/(dp)/publishers	List all the Publishers within a DomainParticipant.
	PUT /applications/(a)/domain_participants/(dp)/publishers/(p)	Enable a Publisher.
	DELETE /applications/(a)/domain_participants/(dp)/publishers/(p)	Delete a Publisher.
QoS Libraries	POST /qos_libraries	Create a new QoS Library.
	GET /qos_libraries	List all the available QoS Libraries.
	DELETE /qos_libraries/(ql)	Delete a QoS Library.
QoS Profiles	POST /qos_libraries/(ql)/qos_profiles	Create a new QoS Profile.
	GET /qos_libraries/(ql)/qos_profiles	List all the QoS Profiles within a QoS Library.
	DELETE /qos_libraries/(ql)/qos_profiles/(qp)	Delete a QoS Profile.
RegisteredTypes	POST /applications/(a)/domain_participants/(dp)/registered_types	Register a Type within a DomainParticipant.
	GET /applications/(a)/domain_participants/(dp)/registered_types	List all the RegisteredTypes within a DomainParticipant.
	DELETE /applications/(a)/domain_participants/(dp)/registered_types/(r)	Unregister a Type within a DomainParticipant.
Subscribers	POST /applications/(a)/domain_participants/(dp)/subscribers	Create a new Subscriber.
	GET /applications/(a)/domain_participants/(dp)/subscribers	List all the Subscribers within a DomainParticipant.
	PUT /applications/(a)/domain_participants/(dp)/subscribers/(s)	Enable a Subscriber.
	DELETE /applications/(a)/domain_participants/(dp)/subscribers/(s)	Delete a Subscriber.
Topics	POST /applications/(a)/domain_participants/(dp)/topics	Create a new Topic.
	GET /applications/(a)/domain_participants/(dp)/topics	List all the Topics within a DomainParticipant.
	PUT /applications/(a)/domain_participants/(dp)/topics/(t)	Enable a Topic.
	DELETE /applications/(a)/domain_participants/(dp)/topics/(t)	Delete a Topic.
Types Library	POST /types	Create one or more new Types.
	GET /types	List all the available Types.
	DELETE /types/(tn)	Delete a Type.

8.2. API Reference¶

POST /applications¶

This method creates an Application given its XML representation. The method instantiates all the entities contained in the application as well.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<application name="ShapesDemo">
  <domain_participant name="ShapesDomainParticipant"
      domain_id="0">
    <register_type name="ShapeType" type_ref="ShapeType" />
    <topic name="Square" register_type_ref="ShapeType" />
    <publisher name="ShapesPublisher"/>
  </domain_participant>
</application>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Application has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications¶

This method returns a list with the names of all the Applications instantiated in the system. Do not supply a request body with this method.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –
- Description: If successful, this method returns a response body with all the Applications instantiated in the system.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <application_list> <application name="anApplication"/> <application name="anotherApplication"/> </application_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /applications/(a)¶

This method deletes an Application given its name. Do not supply a request body with this method.

Parameters

a – Application name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Application has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants¶

This method creates a DomainParticipant given its XML representation.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<domain_participant name="ShapesDomainParticipant"
    domain_ref="MyDomainLibrary::ShapeDomain" domain_id="0">
  <publisher name="MyPublisher">
    <data_writer name="MySquareWriter" topic_ref="Square" />
    <data_writer name="MyCircleWriter" topic_ref="Circle" />
    <data_writer name="MyTriangleWriter" topic_ref="Triangle" />
  </publisher>
</domain_participant>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the DomainParticipant has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants¶

This method returns a list with the names of all the DomainParticipants within a given Application. Do not supply a request body with this method.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –
- Description: If successful, this method returns a response body with the list of Domain Participants within the given Application.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <domain_participant_list> <domain_participant name="aParticipant"/> <domain_participant name="anotherParticpant"/> </domain_participant_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

PUT /applications/(a)/domain_participants/(dp)¶

This method enables a DomainParticipant given its name. Entity objects can be created either enabled or disabled. This operation is idempotent, i.e., calling enable on an already enabled DomainParticipant returns OK and has no effect. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body. Since the “update” operation is idempotent, Web Integration Service will return 204 even if the DomainParticipant is already enabled.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /applications/(a)/domain_participants/(dp)¶

This method deletes a DomainParticipant given its name. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the DomainParticipant has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants/(dp)/publishers¶

This method creates a new Publisher given its XML representation.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml
1
<publisher name="publisherName"/>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Publisher has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants/(dp)/publishers¶

This method returns a list with the names of all the Publishers within the given DomainParticipant. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –
- Description: If successful, this method returns a response body with the list of all Publishers within the given DomainParticipant.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <publisher_list> <publisher name="MyPublisher"/> <publisher name="YourPublisher"/> </publisher_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

PUT /applications/(a)/domain_participants/(dp)/publishers/(p)¶

This method enables a Publisher given its name. Entity objects can be created either enabled or disabled. This operation is idempotent, i.e., calling enable on an already enabled Publisher returns OK and has no effect. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
p – Publisher name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body. Since the “update” operation is idempotent, Web Integration Service will return 204 even if the Publisher is already enabled.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /applications/(a)/domain_participants/(dp)/publishers/(p)¶

This method deletes an existing Publisher given its name. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
p – Publisher name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Publisher has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants/(dp)/publishers/(p)/data_writers¶

This method creates a new DataWriter given its XML representation.

Parameters

a – Application name.
dp – DomainParticipant name.
p – Publisher name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<data_writer name="SquareWriter" topic_ref="Square"/>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the DataWriter has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants/(dp)/publishers/(p)/data_writers¶

This method returns a list with the names of all the DataWriters within the given Publisher. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
p – Publisher name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –

Description: If successful, this method returns a response body with the list of all DataWriters within the given Publisher.

Example Response Body:

application/dds-web+xml

<data_writer_list>
  <data_writer name="MySquareWriter"/>
  <data_writer name="MyCircleWriter"/>
  <data_writer name="MyTriangleWriter"/>
</data_writer_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

PUT /applications/(a)/domain_participants/(dp)/publishers/(s)/data_writers/(dw)¶

This method enables a DataWriter given its name. Entity objects can be created either enabled or disabled. This operation is idempotent, i.e., calling enable on an already enabled DataWriter returns OK and has no effect. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
p – Publisher name.
dw – DataWriter name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body. Since the “update” operation is idempotent, Web Integration Service will return 204 even if the DataWriter is already enabled.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants/(dp)/publishers/(s)/data_writers/(dw)¶

This method writes a data sample using the given DataWriter. In the request body, supply the sample to write using the structure described in the examples. Web Integration Service supports writing samples both in XML (i.e., application/dds-web+xml) and JSON (i.e., application/dds-web+json) format. See examples below.

Parameters

a – Application name.
dp – DomainParticipant name.
p – Publisher name.
dw – DataWriter name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml or application/dds-web+json. See examples below.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<sample>
  <aString>This is a string!</aString>
  <aLong>-123456789</aLong>
  <aShort>125</aShort>
  <anOctet>255</anOctet>
  <aUnsignedShort>5</aUnsignedShort>
  <aUnsignedLong>123456789</aUnsignedLong>
  <aFloat>3.14</aFloat>
  <aDouble>3.1592</aDouble>
  <aBoolean>false</aBoolean>
  <aChar>a</aChar>
  <aWchar>&#x007E;</aWchar>
  <aLongLong>-9223372036854775798</aLongLong>
  <aUnsignedLongLong>14</aUnsignedLongLong>
  <anAlias>false</anAlias>
  <aComplexType>
    <aString>Another string!</aString>
    <aLong>-123456789</aLong>
    <aShort>125</aShort>
    <aUnsignedShort>5</aUnsignedShort>
    <aUnsignedLong>123456789</aUnsignedLong>
    <aFloat>3.14</aFloat>
    <aDouble>3.1592</aDouble>
    <aBoolean>true</aBoolean>
    <aChar>a</aChar>
    <aWchar>&#x007E;</aWchar>
    <aLongLong>9223372036854775798</aLongLong>
    <aUnsignedLongLong>21</aUnsignedLongLong>
    <anEnum>ACE</anEnum>
    <anEnumSeq>
      <item>KING</item>
      <item>QUEEN</item>
      <item>ACE</item>
    </anEnumSeq>
    <anEnumArr>
      <item>ACE</item>
      <item>QUEEN</item>
      <item>KING</item>
    </anEnumArr>
  </aComplexType>
  <anEnum>QUEEN</anEnum>
  <anEnumSeq>
    <item>KING</item>
    <item>QUEEN</item>
    <item>ACE</item>
  </anEnumSeq>
  <anEnumArr>
    <item>ACE</item>
    <item>QUEEN</item>
    <item>KING</item>
  </anEnumArr>
</sample>

application/dds-web+json

{
  "aString": "This is a string!",
  "aLong": -123456789,
  "aShort": 125,
  "anOctet": 255,
  "aUnsignedShort": 5,
  "aUnsignedLong": 123456789,
  "aFloat": 3.14,
  "aDouble": 3.1592,
  "aBoolean": false,
  "aChar": "a",
  "aWchar": "~",
  "aLongLong": -9223372036854775798,
  "aUnsignedLongLong": 9223372036854775798,
  "anAlias": false,
  "aComplexType": {
    "aString": "Another string!",
    "aLong": -123456789,
    "aShort": 125,
    "aUnsignedShort": 5,
    "aUnsignedLong": 123456789,
    "aFloat": 3.14,
    "aDouble": 3.1592,
    "aBoolean": true,
    "aChar": "a",
    "aWchar": "~",
    "aLongLong": -9223372036854775798,
    "aUnsignedLongLong": 9223372036854775798,
    "anEnum": "ACE",
    "anEnumSeq": [ "KING", "QUEEN", "ACE" ],
    "anEnumArr": [ "ACE", "QUEEN", "KING" ]
  },
  "anEnum": "QUEEN",
  "anEnumSeq": [ "KING", "QUEEN" , "ACE" ],
  "anEnumArr": [ "ACE", "QUEEN", "KING" ]
}

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Depending on the Content-Type of the request the Content-Type of the response will be application/dds-web+xml or application/dds-web+json.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the sample has been written.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>
  - application/dds-web+json
    
    1 2 3 4
    { "code": "INVALID_INPUT", "message": "Invalid URL" }

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

application/dds-web+json

{
  "code": "GENERIC_SERVICE_ERROR",
  "message": "Generic error message"
}

DELETE /applications/(a)/domain_participants/(dp)/publishers/(s)/data_writers/(dw)¶

This method deletes an existing DataWriter given its name. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
p – Publisher name.
dw – DataWriter name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the DataWriter has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants/(dp)/registered_types¶

This method registers a Type within a given DomainParticipant. The registered type name is used to refer to a data type within the domain at the time Topics are defined.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<register_type name="ShapeType" type_ref="ShapeType" />

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Type has been registered.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants/(dp)/registered_types¶

This method returns a list with the names of all the Types registered within the given DomainParticipant. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –
- Description: If successful, this method returns a response body with the list of all Types registered within the given DomainParticipant.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <register_type_list> <registered_type name="ShapeType"/> <registered_type name="HelloWorldType"/> </register_type_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /applications/(a)/domain_participants/(dp)/registered_types/(r)¶

This method removes (unregisters) the definition of this type from the given DomainParticipant. This operation does not affect the Topics that have already been created with the given type. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
r – RegisteredType name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the type has been unregistered.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants/(dp)/subscribers¶

This method creates a new Subscriber given its XML representation.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml
1
<subscriber name="subscriberName"/>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Subscriber has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants/(dp)/subscribers¶

This method returns a representation of the list of all the Subscriber objects belonging to the given DomainParticipant. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –
- Description: If successful, this method returns a response body with the list of all Subscribers within the given DomainParticipant.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <subscriber_list> <subscriber name="MySubscriber"/> <subscriber name="YourSubscriber"/> </subscriber_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

PUT /applications/(a)/domain_participants/(dp)/subscribers/(s)¶

This method enables a Subscriber given its name. Entity objects can be created either enabled or disabled. This operation is idempotent, i.e., calling enable on an already enabled Subscriber returns OK and has no effect. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
s – Subscriber name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body. Since the “update” operation is idempotent, Web Integration Service will return 204 even if the Subscriber is already enabled.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /applications/(a)/domain_participants/(dp)/subscribers/(s)¶

This method deletes an existing Subscriber given its name. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
s – Subscriber name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Subscriber has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers¶

This method creates a new DataReader given its XML representation.

Parameters

a – Application name.
dp – DomainParticipant name.
s – Subscriber name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client. application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<data_reader name="SquareReader" topic_ref="Square"/>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the DataReader has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers¶

This method returns a list with the names of all the DataReaders within the given Subscriber. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
s – Subscriber name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –

Description: If successful, this method returns a response body with the list of all DataReaders within the given Subscriber.

Example Response Body:

application/dds-web+xml

<data_reader_list>
  <data_reader name="MySquareReader"/>
  <data_reader name="MyCircleReader"/>
  <data_reader name="MyTriangleReader"/>
</data_reader_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

PUT /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers/(dr)¶

This method enables a DataReader given its name. Entity objects can be created either enabled or disabled. This operation is idempotent, i.e., calling enable on an already enabled DataReader returns OK and has no effect.

Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
s – Subscriber name.
dr – DataReader name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body. Since the “update” operation is idempotent, Web Integration Service will return 204 even if the DataReader is already enabled.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers/(dr)¶

This method retrieves data received by the DataReader given its name. If successful, this method returns a response body with a sequence of samples read.

The operation can be complemented with different optional query parameters, which we describe below.

Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
s – Subscriber name.
dr – DataReader name.

Query Parameters

sampleFormat –
- Description: Optional query parameter to indicate in which format should the read samples be represented. The sampleFormat parameter can be set to either xml or json. If unspecified, it defaults to xml.
- Type: string
- Required: false
- Example:
  GET http://.../dds/rest1/../data_readers/MyDr?sampleFormat="json" HTTP/1.1
prettyPrint –
- Description: Optional query parameter to indicate whether the response should contain indentations and line breaks. If unspecified, it defaults to false.
- Type: boolean
- Required: false
- Example:
  GET http://.../dds/rest1/../data_readers/MyDr?prettyPrint=true HTTP/1.1
enumsAsIntegers –
- Description: Optional query parameter to indicate whether the response should represent enumeration literals as integers. If unspecified, it defaults to false.
- Type: boolean
- Required: false
- Example:
  GET http://.../dds/rest1/../data_readers/MyDr?enumsAsIntegers=true HTTP/1.1
removeFromReaderCache –
- Description: Optional query parameter indicating whether the samples should be removed from the DataReader’s cache (equivalent to DDS’ take operation) or left in the cache (equivalent to DDS’ read operation). The removeFromReaderCache parameter can be set to true or false. If unspecified, it defaults to true, meaning that the samples are removed from the DataReader’s cache.
- Type: boolean
- Required: false
- Example:
  GET http://.../dds/rest1/../data_readers/MyDr?removeFromReaderCache=false HTTP/1.1
maxSamples –
- Description: Optional query parameter indicating the maximum number of samples to retrieve. If unspecified, it defaults to unlimited.
- Type: integer
- Required: false
- Example:
  GET http://.../dds/rest1/../data_readers/MyDr?maxSamples=5 HTTP/1.1
maxWait –
- Description: Optional query parameter indicating the willingness of the caller to wait a certain amount of seconds until the conditions to read data are met. If unspecified it defaults to zero seconds (i.e., maxWait=0).
- Type: integer
- Required: false
- Example:
  GET http://.../dds/rest1/../data_readers/MyDr?maxWait=2 HTTP/1.1
filterExpression –
- Description: A DDS SQL filter expression that is used to create a DDS QueryCondition, which used along with the read or take operations, allows us to generate a list of samples that match it.
- Type: string
- Required: false
- Example:
  GET http://.../dds/rest1/../data_readers/MyDr?filterExpression="x>5" HTTP/1.1
instanceStateMask –
- Description: InstanceStates are used as parameters to the read or take operations to obtain samples that match the desired states. The values that can be used in the mask are: "ALIVE", "NOT_ALIVE_DISPOSED", and "NOT_ALIVE_NO_WRITERS".
- Type: string
- Required: false
- Example:
  GET http://.../data_readers/MyDr?instanceStateMask="ALIVE|NOT_ALIVE_NO_WRITERS" HTTP/1.1
sampleStateMask –
- Description: SampleStates are used as parameters to the read or take operation to obtain samples that match the desired states. The values that can be used in the mask are: "READ" and "NOT_READ".
- Type: string
- Required: false
- Example:
  GET http://.../data_readers/MyDr?sampleStateMask="READ" HTTP/1.1
viewStateMask –
- Description: ViewStates are used as parameters to the read or take operation to obtain samples that match the desired states. The values that can be used in the mask are: "NEW" and "NOT_NEW".
- Type: string
- Required: false
- Example:
  GET http://.../data_readers/MyDr?viewStateMask="NEW" HTTP/1.1

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml or application/dds-web+json. See examples below.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Depending on the Content-Type of the request the Content-Type of the response will be application/dds-web+xml or application/dds-web+json.

Status Codes

204 No Content –

Description: If successful, this method returns a response body with the list of samples read. The list includes information on the sample read, as well as the actual data received. Depending on the required format, the Content-Type of the response will be application/dds-web+xml or application/dds-web+json.

Example Response Body:

application/dds-web+xml

<read_sample_seq>
  <sample>
    <read_sample_info>
      <source_timestamp>
        <sec>1456957176</sec>
        <nanosec>207723000</nanosec>
      </source_timestamp>
      <valid_data>true</valid_data>
      <instance_handle>
        00000000000000000000000000000000
      </instance_handle>
      <instance_state>ALIVE</instance_state>
      <sample_state>NOT_READ</sample_state>
      <view_state>NEW</view_state>
    </read_sample_info>
    <data>
      <aString>This is a string!</aString>
      <aLong>-123456789</aLong>
      <aShort>125</aShort>
      <anOctet>255</anOctet>
      <aUnsignedShort>5</aUnsignedShort>
      <aUnsignedLong>123456789</aUnsignedLong>
      <aFloat>3.140000</aFloat>
      <aDouble>3.159200</aDouble>
      <aBoolean>false</aBoolean>
      <aChar>a</aChar>
      <aWchar>&#x007E;</aWchar>
      <aLongLong>-9223372036854775798</aLongLong>
      <aUnsignedLongLong>14</aUnsignedLongLong>
      <anAlias>false</anAlias>
      <aComplexType>
        <aString>Another string!</aString>
        <aLong>-123456789</aLong>
        <aShort>125</aShort>
        <aUnsignedShort>5</aUnsignedShort>
        <aUnsignedLong>123456789</aUnsignedLong>
        <aFloat>3.140000</aFloat>
        <aDouble>3.159200</aDouble>
        <aBoolean>true</aBoolean>
        <aChar> a</aChar>
        <aWchar>&#x007E;</aWchar>
        <aLongLong>9223372036854775798</aLongLong>
        <aUnsignedLongLong>21</aUnsignedLongLong>
        <anEnum>ACE</anEnum>
        <anEnumSeq>
          <item>KING</item>
          <item>QUEEN</item>
          <item>ACE</item>
        </anEnumSeq>
        <anEnumArr>
          <item>ACE</item>
          <item>QUEEN</item>
          <item>KING</item>
        </anEnumArr>
      </aComplexType>
      <anEnum>QUEEN</anEnum>
      <anEnumSeq>
        <item>KING</item>
        <item>QUEEN</item>
        <item>ACE</item>
      </anEnumSeq>
      <anEnumArr>
        <item>ACE</item>
        <item>QUEEN</item>
        <item>KING</item>
      </anEnumArr>
    </data>
  </sample>
</read_sample_seq>

application/dds-web+json

[
  {
    "read_sample_info":{
      "source_timestamp":{
        "sec":1456962954,
        "nanosec":150101000
      },
      "valid_data":true,
      "instance_handle":"00000000000000000000000000000000",
      "instance_state":"ALIVE",
      "sample_state":"NOT_READ",
      "view_state":"NEW"
    },
    "data":{
      "aString":"This is a string!",
      "aUnion":{
        "aLongUnion":10
      },
      "aLong":-123456789,
      "aShort":125,
      "anOctet":255,
      "aUnsignedShort":5,
      "aUnsignedLong":123456789,
      "aFloat":3.140000,
      "aDouble":3.159200,
      "aBoolean":false,
      "aChar":"a",
      "aWchar":"~",
      "aLongLong":-9223372036854775798,
      "aUnsignedLongLong":9223372036854775798,
      "anAlias":false,
      "aComplexType":{
        "aString":"Another string!",
        "aUnionI":{
          "aLongUnion":10
        },
        "aLong":-123456789,
        "aShort":125,
        "aUnsignedShort":5,
        "aUnsignedLong":123456789,
        "aFloat":3.140000,
        "aDouble":3.159200,
        "aBoolean":true,
        "aChar":"a",
        "aWchar":"~",
        "aLongLong":-9223372036854775798,
        "aUnsignedLongLong":9223372036854775798,
        "anEnum":"ACE",
        "anEnumSeq":["KING","QUEEN","ACE"],
        "anEnumArr":["ACE","QUEEN","KING"]
      },
      "anEnum":"QUEEN",
      "anEnumSeq":["KING","QUEEN","ACE"],
      "anEnumArr":["ACE","QUEEN","KING"]
    }
  }
]

404 Not Found –
- Description: In case of error in DDS’ read or take operation, this method returns a response body with the error code INVALID_OBJECT and a message describing the error. Depending on the sampleFormat of the request, the Content-Type of the response will be application/dds-web+xml or application/dds-web+json.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_OBJECT</code> <message>Error message</message> </error>
  - application/dds-web+json
    
    1 2 3 4
    { "code": "INVALID_OBJECT", "message": "Error message" }
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message. Depending on the sampleFormat of the request, the Content-Type of the response will be application/dds-web+xml or application/dds-web+json.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error>,12,1 <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>
  - application/dds-web+json
    
    1 2 3 4
    { "code": "INVALID_INPUT", "message": "Invalid URL" }
500 Internal Server Error –
- Description: DDS error or generic server error. Depending on the sampleFormat indicated in the request, the Content-Type of the response will be application/dds-web+xml or application/dds-web+json.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>GENERIC_SERVICE_ERROR</code> <message>Generic error message</message> </error>
  - application/dds-web+json
    
    1 2 3 4
    { "code": "GENERIC_SERVICE_ERROR", "message": "Generic error message" }

DELETE /applications/(a)/domain_participants/(dp)/subscribers/(s)/data_readers/(dr)¶

This method deletes an existing DataReader given its name.

Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
s – Subscriber name.
dr – DataReader name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the DataReader has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /applications/(a)/domain_participants/(dp)/topics¶

This method creates a new Topic given its XML representation.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<topic name="Square" register_type_ref="ShapeType"/>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Topic has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /applications/(a)/domain_participants/(dp)/topics¶

This method returns a list with the names of all the Topics within a given DomainParticipant. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –
- Description: If successful, this method returns a response body with the list of Topics within the given DomainParticipant.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <topic_list> <topic name="Square"/> <topic name="Triangle"/> </topic_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

PUT /applications/(a)/domain_participants/(dp)/topics/(t)¶

This method enables a Topic given its name. Entity objects can be created either enabled or disabled. This operation is idempotent, i.e., calling enable on an already enabled Topic returns OK and has no effect. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
t – Topic name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body. Since the “update” operation is idempotent, Web Integration Service will return 204 even if the Topic is already enabled.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /applications/(a)/domain_participants/(dp)/topics/(t)¶

This method deletes a Topic given its name. Do not supply a request body with this method.

Parameters

a – Application name.
dp – DomainParticipant name.
t – Topic name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Topic has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /domain_libraries¶

This method creates a Domain Library given its XML representation.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<domain_library name="MyDomainLibrary">
  <domain name="ShapeDomain" domain_id="0">
    <register_type name="ShapeType" type_ref="ShapeType"/>
    <topic name="Square" register_type_ref="ShapeType" />
    <topic name="Circle" register_type_ref="ShapeType" />
    <topic name="Triangle" register_type_ref="ShapeType" />
  </domain>
</domain_library>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Domain Library has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /domain_libraries¶

This method returns a list with the names of all the available Domain Libraries. Do not supply a request body with this method.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –
- Description: If successful, this method returns a response body with all the available Domain Libraries.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <domain_library_list> <domain_library name="aDomainLibrary"/> <domain_library name="anotherDomainLibrary"/> </domain_library_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /domain_libraries/(dl)¶

This method deletes a Domain Library given its type name. Do not supply a request body with this method.

Parameters

dl – Domain Library name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the Domain Library has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /qos_libraries¶

This method creates a QoS Library given its XML representation.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<qos_library name="qosLibrary">
  <qos_profile name="defaultProfile" is_default_qos="true">
    <domain_participant_qos>
      <resource_limits>
        <type_code_max_serialized_length>
          32000
        </type_code_max_serialized_length>
        <type_object_max_serialized_length>
          32000
        </type_object_max_serialized_length>
      </resource_limits>
    </domain_participant_qos>
  </qos_profile>
</qos_library>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the QoS Library has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /qos_libraries¶

This method returns a list with all the available QoS Libraries. Do not supply a request body with this method.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –

Description: If successful, this method returns a response body with all the available QoS Libraries.

Example Response Body:

application/dds-web+xml

<qos_library_list>
  <qos_library name="qosLibrary">
    <qos_profile name="myProfile">
      <!-- ... -->
    </qos_profile>
  </qos_library>
  <qos_library name ="anotherQosLibrary">
    <qos_profile name="anotherQosProfile">
      <!-- ... -->
    </qos_profile>
  </qos_library>
</qos_library_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /qos_libraries/(ql)¶

This method deletes a QoS Library given its type name. Do not supply a request body with this method.

Parameters

ql – QoS Library name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the QoS Library has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /qos_libraries/(ql)/qos_profiles¶

This method creates a QoS Profile given its XML representation.

Parameters

ql – QoS Library name.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<qos_profile name="defaultProfile" is_default_qos="true">
  <domain_participant_qos>
    <resource_limits>
      <type_code_max_serialized_length>
        32000
      </type_code_max_serialized_length>
      <type_object_max_serialized_length>
        32000
      </type_object_max_serialized_length>
    </resource_limits>
  </domain_participant_qos>
</qos_profile>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the QoS Profile has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /qos_libraries/(ql)/qos_profiles¶

This method returns a list with all the available QoS Profiles within a QoS Library. Do not supply a request body with this method.

Parameters

ql – QoS Library name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –

Description: If successful, this method returns a response body with all the available QoS Profiles within the given QoS Library.

Example Response Body:

application/dds-web+xml

<qos_profile_list>
  <qos_profile name="myProfile">
    <!-- ... -->
  <qos_profile name="anotherQosProfile">
    <!-- ... -->
  </qos_profile>
</qos_profile_list>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /qos_libraries/(ql)/qos_profiles/(qp)¶

This method deletes a QoS Profile given its type name. Do not supply a request body with this method.

Parameters

ql – QoS Library name.
qn – QoS Profile name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the QoS Profile has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

POST /types¶

This method creates one or more types given their XML representation.

Request Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.
OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Example Request Body

application/dds-web+xml

<types>
    <const name="MAX_COLOR_LEN" type="long" value="128"/>
        <struct name="ShapeType">
            <member name="color" type="string" stringMaxLength="128" key="true"/>
            <member name="x" type="long"/>
            <member name="y" type="long"/>
            <member name="shapesize" type="long"/>
        </struct>
</types>

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the type has been created.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

GET /types¶

This method returns an XML representation of all the available types. Do not supply a request body with this method.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

200 OK –

Description: If successful, this method returns a response body with all the available types.

Example Response Body:

application/dds-web+xml

<types>
  <const name="MAX_COLOR_LEN" type="long" value="128"/>
  <struct name="ShapeType">
    <member name="color" type="string" stringMaxLength="128" key="true"/>
    <member name="x" type="long"/>
    <member name="y" type="long"/>
    <member name="shapesize" type="long"/>
  </struct>
</types>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>

DELETE /types/(tn)¶

This method deletes a Type given its type name. Do not supply a request body with this method.

Parameters

tn – Type name.

Request Headers

OMG-DDS-API-Key – Key that authorizes the client application for the operation being performed. This header is only required if authentication is enabled on the server.

Response Headers

Content-Length – Transfer-length of the message-body.
Content-Type – Valid values: application/dds-web+xml.

Status Codes

204 No Content –
- Description: If successful, this method returns an empty response body indicating that the type has been deleted.
422 Unprocessable Entity –
- Description: In case of an invalid input this method returns a response body with the error code and a message.
- Example Response Body:
  - application/dds-web+xml
    
    1 2 3 4
    <error> <code>INVALID_INPUT</code> <message>Invalid URL</message> </error>

500 Internal Server Error –

Description: DDS error or generic server error.

Example Response Body:

application/dds-web+xml

<error>
    <code>GENERIC_SERVICE_ERROR</code>
    <message>Generic error message</message>
</error>