API Reference

All URIs below have the prefix http[s]://server[:port]/dds/rest1

/dds/rest1/types — Types Library

The Types Library is a collection of data types specified in XML that can be used across applications.

post get

post

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

get

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

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

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body

  • Content-Type: required (string)

    Valid values: application/dds-web+xml

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 204

If successful, this method returns an empty response body indicating that the type has been created.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

delete

delete

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

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

URI Parameters

  • tp: required (string)

    Type name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input, for instance, an invalid type name this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

/dds/rest1/qos_libraries — Qos Libraries

A QoS Library is a collection of Qos Profiles and/or QoS settings, specified in XML format, that can be used across applications.

post get

post

This method creates a QoS Library given its XML representation.

get

This method returns a list with all the available QoS Libraries.

This method creates a QoS Library given its XML representation.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body

  • Content-Type: required (string)

    Valid values: application/dds-web+xml

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

<qos_library name="qosLibrary">
  <qos_profile name="defaultProfile" is_default_qos="true">
    <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>
    </participant_qos>
  </qos_profile>
</qos_library>

HTTP status code 204

If successful, this method returns an empty response body indicating that the type has been created.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

delete

delete

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

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

URI Parameters

  • ql: required (string)

    QoS Library name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body indicating that the type has been created.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

A QoS profile is a collection of QoS settings, usually one per entity, specified in XML format.

post

This method creates a QoS Profile given its XML representation.

get

This method returns a list with all the available QoS Profiles within a QoS Library.

This method creates a QoS Profile given its XML representation.

URI Parameters

  • ql: required (string)

    QoS Library name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body

  • Content-Type: required (string)

    Valid values: application/dds-web+xml

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

<qos_profile name="defaultProfile" is_default_qos="true">
  <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>
  </participant_qos>
</qos_profile>

HTTP status code 204

If successful, this method returns an empty response body indicating that the type has been created.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

This method returns a list with all the available QoS Profiles within a QoS Library.

URI Parameters

  • ql: required (string)

    QoS Library name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

If successful, this method returns a response body with all the avaiable QoS Profiles within the given Qos Library.

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

delete

delete

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

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

URI Parameters

  • ql: required (string)

    QoS Library name.

  • qp: required (string)

    QoS Profile name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

/dds/rest1/domain_libraries — Domain Libraries

A Domain Library provides a way to organize a set of domains that belong to the same system. Domain Libraries can be shared across applications.

post get

post

This method creates a Domain library given its XML representation.

get

This method returns a list with the names of all the available Domain Libraries.

This method creates a Domain library given its XML representation.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

<domain_library name="MyDomainLibrary">
  <domain name="ShapeDomain" domain_id="0">
     <register_type name="ShapeType" kind="dynamicData" 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>

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

delete

delete

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

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

URI Parameters

  • dl: required (string)

    Domain Library name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

/dds/rest1/applications — Applications

An Application is a collection of instantiated DomainParticipants.

post get

post

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

get

This method returns a list with the names of all the Applications instantiated in the system.

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

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

delete

delete

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

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

URI Parameters

  • a: required (string)

    Application name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

post

This method creates a DomainParticipant given its XML representation.

get

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.

This method creates a DomainParticipant given its XML representation.

URI Parameters

  • a: required (string)

    Application name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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.

URI Parameters

  • a: required (string)

    Application name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

If successful, this method returns a response body with the list of Domain Participants within the the given Application.

Body

Type: application/dds-web+xml

Example:

<domain_participant_list>
  <domain_participant name="ShapeSubscriber"/>
  <domain_participant name="ShapePublisher"/>
</domain_participant_list>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

put delete

put

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.

delete

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

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.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

post

This method creates a new Topic given its XML representation.

get

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.

This method creates a new Topic given its XML representation.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

If successful, this method returns a response body with the list of the Topics within the the given DomainParticipant.

Body

Type: application/dds-web+xml

Example:

<topic_list>
  <topic name="ShapeSubscriber"/>
  <topic name="ShapePublisher"/>
</topic_list>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

delete

delete

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

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

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • t: required (string)

    Topic name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

post

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.

get

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.

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

If successful, this method returns a response body with the names of all Types registered within the the given DomainParticipant.

Body

Type: application/dds-web+xml

Example:

<register_type_list>
  <registered_type name="ShapeSubscriber"/>
  <registered_type name="ShapePublisher"/>
</register_type_list>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

delete

delete

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.

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • r: required (string)

    Registered Type name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

post

This method creates a new Publisher given its XML representation.

get

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.

This method creates a new Publisher given its XML representation.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

<publisher name="publisherName"/>

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

If successful, this method returns a response body with a list of the names of all the Publishers within the given DomainParticipant.

Body

Type: application/dds-web+xml

Example:

<publisher_list>
  <publisher name="MyPublisher"/>
  <publisher name="YourPublisher"/>
</publisher_list>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

put delete

put

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.

delete

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • p: required (string)

    Publisher name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

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.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • p: required (string)

    Publisher name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

post

This method creates a new DataWriter given its XML representation.

get

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.

This method creates a new DataWriter given its XML representation.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • p: required (string)

    Publisher name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • p: required (string)

    Publisher name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post put delete

post

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.

put

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.

delete

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • p: required (string)

    Publisher name.

  • dw: required (string)

    DataWriter name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml" or "application/dds-web+json". See examples below.

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

<sample>
    <aString>This is a string!</aString>
    <aLong>-123456789</aLong>
    <aShort>125</aShort>
    <anOctet>0xff</anOctet>
    <aUnsignedShort>5</aUnsignedShort>
    <aUnsignedLong>123456789</aUnsignedLong>
    <aFloat>3.14</aFloat>
    <aDouble>3.1592</aDouble>
    <aBoolean>false</aBoolean>
    <aChar>a</aChar>
    <aWchar>0x0000007e</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>0x0000007e</aWchar>
        <aLongLong>9223372036854775798</aLongLong>
        <aUnsignedLongLong>21</aUnsignedLongLong>
        <anEnum>12</anEnum>
        <anEnumSeq>
            <item>13</item>
            <item>12</item>
            <item>1</item>
        </anEnumSeq>
        <anEnumArr>
            <item>1</item>
            <item>12</item>
            <item>13</item>
        </anEnumArr>
    </aComplexType>
    <anEnum>12</anEnum>
    <anEnumSeq>
        <item>13</item>
        <item>12</item>
        <item>1</item>
    </anEnumSeq>
    <anEnumArr>
        <item>1</item>
        <item>12</item>
        <item>13</item>
    </anEnumArr>
</sample>

Type: application/dds-web+json

Example:

{
  "aString": "This is a string!",
  "aLong": -123456789,
  "aShort": 125,
  "anOctet": "0xff",
  "aUnsignedShort": 5,
  "aUnsignedLong": 123456789,
  "aFloat": 3.14,
  "aDouble": 3.1592,
  "aBoolean": false,
  "aChar": "a",
  "aWchar": "0x0000007e",
  "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": "0x0000007e",
      "aLongLong": -9223372036854775798,
      "aUnsignedLongLong": 9223372036854775798,
      "anEnum": 1,
      "anEnumSeq": [ 13, 12, 1 ],
      "anEnumArr": [ 1, 12, 13 ]
  },
  "anEnum": 12,
  "anEnumSeq": [ 13, 12 , 1 ],
  "anEnumArr": [ 1, 12, 13 ]
}

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message. 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".

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

Type: application/dds-web+json

Example:

{
  "code": "INVALID_INPUT",
  "message": "Invalid URL"
}

HTTP status code 500

DDS error or generic server error. 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".

Body

Type: application/dds-web+xml

Example:

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

Type: application/dds-web+json

Example:

{
  "code": "INVALID_INPUT",
  "message": "Invalid URL"
}
</error>

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • p: required (string)

    Publisher name.

  • dw: required (string)

    DataWriter name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

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.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • p: required (string)

    Publisher name.

  • dw: required (string)

    DataWriter name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

post

This method creates a new Subscriber given its XML representation.

get

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.

This method creates a new Subscriber given its XML representation.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

<subscriber name="subscriberName"/>

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

If successful, this method returns a response body with the list of Subscribers within the the given DomainParticipant.

Body

Type: application/dds-web+xml

Example:

<subscriber_list>
  <subscriber name="MySubscriber"/>
  <subscriber name="YourSubscriber"/>
</subscriber_list>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

put delete

put

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 Subscrber returns OK and has no effect.

delete

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

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 Subscrber returns OK and has no effect.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • s: required (string)

    Subscriber name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

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.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • s: required (string)

    Subscriber name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

post get

post

This method creates a new DataReader given its XML representation.

get

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.

This method creates a new DataReader given its XML representation.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • s: required (string)

    Subscriber name.

Headers

  • Content-Length: required (string)

    Transfer-length of the message-body.

  • Content-Type: required (string)

    Valid values: "application/dds-web+xml".

  • OMG-DDS-API-Key: (string)

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • s: required (string)

    Subscriber name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 200

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

Body

Type: application/dds-web+xml

Example:

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

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

get put delete

get

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.

put

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.

delete

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

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • s: required (string)

    Subscriber name.

  • dr: required (string)

    DataReader name.

Headers

  • OMG-DDS-API-Key: (string)

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

Query Parameters

  • sampleFormat: (string)

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

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?sampleFormat="json"
  • removeFromReaderCache: (boolean)

    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.

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?removeFromReaderCache=false
  • maxSamples: (integer)

    Optional query parameter indicating the maximum number of samples to retrieve. If unspecified, it defaults to unlimited.

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?maxSamples=5
  • maxWait: (integer)

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

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?maxWait=2
  • filterExpression: (string)

    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.

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?maxWait=2
  • instanceStateMask: (string)

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

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?instanceStateMask="ALIVE|NOT_ALIVE_NO_WRITERS"
  • sampleStateMask: (string)

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

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?sampleStateMask="READ"
  • viewStateMask: (string)

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

    Example:

    GET http://.../dds/rest1/../data_readers/MyDr?viewStateMask="NEW"

HTTP status code 200

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

Body

Type: application/dds-web+xml

Example:

<read_sample_seq>
  <sample>
    <read_sample_info>
        <source_timestamp>
            <sec>1456957176</sec>
            <nanosec>207723000</nanosec>
        </source_timestamp>
        <valid_data>true</valid_data>
        <instance_handle>
          0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
        </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>0xff</anOctet>
      <aUnsignedShort>5</aUnsignedShort>
      <aUnsignedLong>123456789</aUnsignedLong>
      <aFloat>3.140000</aFloat>
      <aDouble>3.159200</aDouble>
      <aBoolean>false</aBoolean>
      <aChar>a</aChar>
      <aWchar>0x0000007e</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>0x0000007e</aWchar>
            <aLongLong>9223372036854775798</aLongLong>
            <aUnsignedLongLong>21</aUnsignedLongLong>
            <anEnum>12</anEnum>
            <anEnumSeq>
              <item>13</item>
              <item>12</item>
              <item>1</item>
            </anEnumSeq>
            <anEnumArr>
              <item>1</item>
              <item>12</item>
              <item>13</item>
            </anEnumArr>
        </aComplexType>
        <anEnum>12</anEnum>
        <anEnumSeq>
          <item>13</item>
          <item>12</item>
          <item>1</item>
        </anEnumSeq>
        <anEnumArr>
          <item>1</item>
          <item>12</item>
          <item>13</item>
        </anEnumArr>
    </data>
  </sample>
</read_sample_seq>

Type: application/dds-web+json

Example:

[
  {
    "read_sample_info":{
      "source_timestamp":{
        "sec":1456962954,
        "nanosec":150101000
      },
      "valid_data":true,
      "instance_handle":"0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0",
      "instance_state":"ALIVE",
      "sample_state":"NOT_READ",
      "view_state":"NEW"
    },
    "data":{
      "aString":"This is a string!",
      "aUnion":{
        "aLongUnion":10
      },
      "aLong":-123456789,
      "aShort":125,
      "anOctet":"0xff",
      "aUnsignedShort":5,
      "aUnsignedLong":123456789,
      "aFloat":3.140000,
      "aDouble":3.159200,
      "aBoolean":false,
      "aChar":"a",
      "aWchar":"0x0000007e",
      "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":"0x0000007e",
        "aLongLong":-9223372036854775798,
        "aUnsignedLongLong":9223372036854775798,
        "anEnum":1,
        "anEnumSeq":[13,12,1],
        "anEnumArr":[1,12,13]
      },
      "anEnum":12,
      "anEnumSeq":[13, 12, 1],
      "anEnumArr":[1, 12, 13]
    }
  }
]

HTTP status code 404

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

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_OBJECT</code>
  <message>Error message</message>
</error>

Type: application/dds-web+json

Example:

{
  "code": "INVALID_OBJECT",
  "message": "Error message"
}

HTTP status code 422

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

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

Type: application/dds-web+json

Example:

{
  "code": "INVALID_INPUT",
  "message": "Invalid URL"
}

HTTP status code 500

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

Body

Type: application/dds-web+xml

Example:

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

Type: application/dds-web+json

Example:

{
  "code": "INVALID_INPUT",
  "message": "Invalid URL"
}

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.

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • s: required (string)

    Subscriber name.

  • dr: required (string)

    DataReader name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

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.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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

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

URI Parameters

  • a: required (string)

    Application name.

  • dp: required (string)

    DomainParticipant name.

  • s: required (string)

    Subscriber name.

  • dr: required (string)

    DataReader name.

Headers

  • OMG-DDS-API-Key: (string)

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

HTTP status code 204

If successful, this method returns an empty response body.

HTTP status code 422

In case of an invalid input this method returns a response body with the error code and a message.

Body

Type: application/dds-web+xml

Example:

<error>
  <code>INVALID_INPUT</code>
  <message>Invalid URL</message>
</error>

HTTP status code 500

DDS error or generic server error.

Body

Type: application/dds-web+xml

Example:

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