9. API Reference
9.1. API Overview
9.2. API Reference
- POST /dds/rest1/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+xml1<application name="ShapesDemo"> 2 <domain_participant name="ShapesDomainParticipant" 3 domain_id="0"> 4 <register_type name="ShapeType" type_ref="ShapeType" /> 5 <topic name="Square" register_type_ref="ShapeType" /> 6 <publisher name="ShapesPublisher"/> 7 </domain_participant> 8</application>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the Application has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<application_list> 2 <application name="anApplication"/> 3 <application name="anotherApplication"/> 4</application_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the Application has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<domain_participant name="ShapesDomainParticipant" 2 domain_ref="MyDomainLibrary::ShapeDomain" domain_id="0"> 3 <publisher name="MyPublisher"> 4 <data_writer name="MySquareWriter" topic_ref="Square" /> 5 <data_writer name="MyCircleWriter" topic_ref="Circle" /> 6 <data_writer name="MyTriangleWriter" topic_ref="Triangle" /> 7 </publisher> 8</domain_participant>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the DomainParticipant has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<domain_participant_list> 2 <domain_participant name="aParticipant"/> 3 <domain_participant name="anotherParticpant"/> 4</domain_participant_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the DomainParticipant has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- PUT /dds/rest1/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:
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.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/applications/(a)/domain_participants/(dp)/builtin_subscribers
This method returns a list of all the builtin Subscribers that belong 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 a list of all the builtin Subscribers within the given DomainParticipant.
Example Response Body:
application/dds-web+xml1<builtin_subscriber_list> 2 <builtin_subscriber name="Default"/> 3</builtin_subscriber_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- PUT /dds/rest1/applications/(a)/domain_participants/(dp)/builtin_subscribers/(bs)
This method enables a builtin Subscriber given its name. Builtin Subscribers must be created before being used. This operation forces their creation. This operation is idempotent, i.e., calling enable on an already enabled builtin Subscriber returns OK and has no effect. Do not supply a request body with this method.
- Parameters:
a – Application name.
dp – DomainParticipant name.
bs – Builtin 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:
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 builtin Subscriber is already enabled.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/applications/(a)/domain_participants/(dp)/builtin_subscribers/(bs)/builtin_data_readers
This method returns a list with the names of all the builtin DataReaders within the given builtin Subscriber. Do not supply a request body with this method.
- Parameters:
a – Application name.
dp – DomainParticipant name.
bs – Builtin 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 builtin DataReaders within the given builtin Subscriber.
Example Response Body:
application/dds-web+xml1<builtin_data_reader_list> 2 <builtin_data_reader name="ParticipantReader"/> 3 <builtin_data_reader name="PublicationReader"/> 4 <builtin_data_reader name="SubscriptionReader"/> 5</builtin_data_reader_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/applications/(a)/domain_participants/(dp)/builtin_subscribers/(bs)/builtin_data_readers/(bdr)
This method retrieves discovery data received by the builtin 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.
bs – Builtin Subscriber name.
bdr – Builtin DataReader name.
- Query Parameters:
sampleFormat –
Description: Optional query parameter to indicate in which format should the read samples be represented. The
sampleFormatparameter can be set to eitherxmlorjson. If unspecified, it defaults toxml.Type:
stringRequired: false
Example:
GET http://.../dds/rest1/../builtin_data_readers/ParticipantReader?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:
booleanRequired: false
Example:
GET http://.../dds/rest1/../builtin_data_readers/ParticipantReader?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:
booleanRequired: false
Example:
GET http://.../dds/rest1/../builtin_data_readers/ParticipantReader?enumsAsIntegers=true HTTP/1.1
removeFromReaderCache –
Description: Optional query parameter indicating whether the samples should be removed from the builtin DataReader’s cache (equivalent to DDS’ take operation) or left in the cache (equivalent to DDS’ read operation). The
removeFromReaderCacheparameter can be set totrueorfalse. If unspecified, it defaults totrue, meaning that the samples are removed from the builtin DataReader’s cache.Type:
booleanRequired: false
Example:
GET http://.../dds/rest1/../builtin_data_readers/ParticipantReader?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:
integerRequired: false
Example:
GET http://.../dds/rest1/../builtin_data_readers/ParticipantReader?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:
integerRequired: false
Example:
GET http://.../dds/rest1/../builtin_data_readers/ParticipantReader?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:
stringRequired: false
Example:
GET http://.../dds/rest1/../builtin_data_readers/ParticipantReader?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:
stringRequired: false
Example:
GET http://.../builtin_data_readers/ParticipantReader?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:
stringRequired: false
Example:
GET http://.../builtin_data_readers/ParticipantReader?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:
stringRequired: false
Example:
GET http://.../builtin_data_readers/ParticipantReader?viewStateMask="NEW" HTTP/1.1
- Request Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xmlorapplication/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+xmlorapplication/dds-web+json.
- Status Codes:
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-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<read_sample_seq> 2 <sample> 3 <read_sample_info> 4 <source_timestamp> 5 <sec>1456957176</sec> 6 <nanosec>207723000</nanosec> 7 </source_timestamp> 8 <valid_data>true</valid_data> 9 <instance_handle> 10 00000000000000000000000000000000 11 </instance_handle> 12 <instance_state>ALIVE</instance_state> 13 <sample_state>NOT_READ</sample_state> 14 <view_state>NEW</view_state> 15 </read_sample_info> 16 <data> 17 <key> 18 <value> 19 <item>16869094</item> 20 <item>174727750</item> 21 <item>3283168865</item> 22 <item>449</item> 23 </value> 24 </key> 25 <user_data> 26 <value> 27 </value> 28 </user_data> 29 <property> 30 <value> 31 <item> 32 <name>dds.sys_info.hostname</name> 33 <value>RTI-00000</value> 34 <propagate>true</propagate> 35 </item> 36 <item> 37 <name>dds.sys_info.process_id</name> 38 <value>11275</value> 39 <propagate>true</propagate> 40 </item> 41 <item> 42 <name>dds.sys_info.username</name> 43 <value>username</value> 44 <propagate>true</propagate> 45 </item> 46 <item> 47 <name>dds.sys_info.executable_filepath</name> 48 <value>/path/to/executable</value> 49 <propagate>true</propagate> 50 </item> 51 <item> 52 <name>dds.sys_info.target</name> 53 <value>x64Linux2.6gcc4.4.5</value> 54 <propagate>true</propagate> 55 </item> 56 <item> 57 <name>dds.sys_info.creation_timestamp</name> 58 <value>2021-03-9 16:18:33Z</value> 59 <propagate>true</propagate> 60 </item> 61 <item> 62 <name>dds.sys_info.execution_timestamp</name> 63 <value>2021-06-23 12:04:08Z</value> 64 <propagate>true</propagate> 65 </item> 66 </value> 67 </property> 68 <rtps_protocol_version> 69 <major>2</major> 70 <minor>3</minor> 71 </rtps_protocol_version> 72 <rtps_vendor_id> 73 <vendorId> 74 <item>1</item> 75 <item>1</item> 76 </vendorId> 77 </rtps_vendor_id> 78 <dds_builtin_endpoints>3135</dds_builtin_endpoints> 79 <default_unicast_locators> 80 <item> 81 <kind>IPv4</kind> 82 <port>32661</port> 83 <address>192.168.1.8</address> 84 </item> 85 <item> 86 <kind>IPv4</kind> 87 <port>32661</port> 88 <address>10.2.190.37</address> 89 </item> 90 <item> 91 <kind>IPv6</kind> 92 <port>32661</port> 93 <address>4C86:164D:99A5:7A37:F243:12CE:0000:0000</address> 94 </item> 95 </default_unicast_locators> 96 <product_version> 97 <major>6</major> 98 <minor>0</minor> 99 <release>1</release> 100 <revision>0</revision> 101 </product_version> 102 <participant_name> 103 <name>RTI Shapes Demo</name> 104 <role_name></role_name> 105 </participant_name> 106 <domain_id>101</domain_id> 107 <transport_info> 108 <item> 109 <class_id>1</class_id> 110 <message_size_max>65507</message_size_max> 111 </item> 112 <item> 113 <class_id>16777216</class_id> 114 <message_size_max>65536</message_size_max> 115 </item> 116 </transport_info> 117 <reachability_lease_duration> 118 <sec>2147483647</sec> 119 <nanosec>2147483647</nanosec> 120 </reachability_lease_duration> 121 </data> 122 </sample> 123</read_sample_seq>
application/dds-web+json1[ 2 { 3 "read_sample_info":{ 4 "source_timestamp":{ 5 "sec":1456962954, 6 "nanosec":150101000 7 }, 8 "valid_data":true, 9 "instance_handle":"00000000000000000000000000000000", 10 "instance_state":"ALIVE", 11 "sample_state":"NOT_READ", 12 "view_state":"NEW" 13 }, 14 "data":{ 15 "key":{ 16 "value":[16862963,2600599664,479217962,449] 17 }, 18 "user_data":{ 19 "value":[] 20 }, 21 "property":{ 22 "value":[ 23 { 24 "name":"dds.sys_info.hostname", 25 "value":"RTI-00000", 26 "propagate":true 27 }, 28 { 29 "name":"dds.sys_info.process_id", 30 "value":"8223", 31 "propagate":true 32 }, 33 { 34 "name":"dds.sys_info.username", 35 "value":"username", 36 "propagate":true 37 }, 38 { 39 "name":"dds.sys_info.executable_filepath", 40 "value":"/path/to/exectuable", 41 "propagate":true 42 }, 43 { 44 "name":"dds.sys_info.target", 45 "value":"x64Linux2.6gcc4.4.5", 46 "propagate":true 47 }, 48 { 49 "name":"dds.sys_info.creation_timestamp", 50 "value":"2021-03-9 16:18:33Z", 51 "propagate":true 52 }, 53 { 54 "name":"dds.sys_info.execution_timestamp", 55 "value":"2021-06-23 12:04:08Z", 56 "propagate":true 57 }] 58 }, 59 "rtps_protocol_version":{ 60 "major":2, 61 "minor":3 62 }, 63 "rtps_vendor_id":{ 64 "vendorId":[1,1] 65 }, 66 "dds_builtin_endpoints":3135, 67 "default_unicast_locators":[ 68 { 69 "kind":"IPv4", 70 "port":32661, 71 "address":"192.168.1.8" 72 }, 73 { 74 "kind":"IPv4", 75 "port":32661, 76 "address":"10.2.190.37" 77 }, 78 { 79 "kind":"IPv6", 80 "port":32661, 81 "address":"4C86:164D:99A5:7A37:F243:12CE:0000:0000" 82 }], 83 "product_version":{ 84 "major":6, 85 "minor":0, 86 "release":1, 87 "revision":0 88 }, 89 "participant_name":{ 90 "name":"RTI Shapes Demo", 91 "role_name":"" 92 }, 93 "domain_id":101, 94 "transport_info":[ 95 { 96 "class_id":1, 97 "message_size_max":65507 98 }, 99 { 100 "class_id":16777216, 101 "message_size_max":65536 102 }], 103 "reachability_lease_duration":{ 104 "sec":2147483647, 105 "nanosec":2147483647 106 } 107 } 108 } 109]
Description: In case of error in DDS’ read or take operation, this method returns a response body with the error code
INVALID_OBJECTand a message describing the error. Depending on thesampleFormatof the request, theContent-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<error> 2 <code>INVALID_OBJECT</code> 3 <message>Error message</message> 4</error>
application/dds-web+json1{ 2 "code": "INVALID_OBJECT", 3 "message": "Error message" 4}
Description: In case of an invalid input this method returns a response body with the error code and a message. Depending on the
sampleFormatof the request, theContent-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
application/dds-web+json1{ 2 "code": "INVALID_INPUT", 3 "message": "Invalid URL" 4}
Description: DDS error or generic server error. Depending on the sampleFormat indicated in the request, the
Content-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
application/dds-web+json1{ 2 "code": "GENERIC_SERVICE_ERROR", 3 "message": "Generic error message" 4}
- PUT /dds/rest1/applications/(a)/domain_participants/(dp)/builtin_subscribers/(bs)/builtin_data_readers/(bdr)
This method enables a builtin DataReader given its name. Builtin DataReaders must be created before being used. This operation forces their creation. This operation is idempotent, i.e., calling enable on an already enabled builtin DataReader returns OK and has no effect.
Do not supply a request body with this method.
- Parameters:
a – Application name.
dp – DomainParticipant name.
bs – Builtin Subscriber name.
bdr – Builtin 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:
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 builtin DataReader is already enabled.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<publisher name="publisherName"/>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the Publisher has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<publisher_list> 2 <publisher name="MyPublisher"/> 3 <publisher name="YourPublisher"/> 4</publisher_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the Publisher has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- PUT /dds/rest1/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:
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.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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
1<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:
Description: If successful, this method returns an empty response body indicating that the DataWriter has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<data_writer_list> 2 <data_writer name="MySquareWriter"/> 3 <data_writer name="MyCircleWriter"/> 4 <data_writer name="MyTriangleWriter"/> 5</data_writer_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xmlorapplication/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+xml1<sample> 2 <aString>This is a string!</aString> 3 <aLong>-123456789</aLong> 4 <aShort>125</aShort> 5 <anOctet>255</anOctet> 6 <aUnsignedShort>5</aUnsignedShort> 7 <aUnsignedLong>123456789</aUnsignedLong> 8 <aFloat>3.75</aFloat> 9 <aDouble>3.1591</aDouble> 10 <aBoolean>false</aBoolean> 11 <aChar>a</aChar> 12 <aWchar>~</aWchar> 13 <aLongLong>-9223372036854775798</aLongLong> 14 <aUnsignedLongLong>14</aUnsignedLongLong> 15 <anAlias>false</anAlias> 16 <aComplexType> 17 <aString>Another string!</aString> 18 <aLong>-123456789</aLong> 19 <aShort>125</aShort> 20 <aUnsignedShort>5</aUnsignedShort> 21 <aUnsignedLong>123456789</aUnsignedLong> 22 <aFloat>3.75</aFloat> 23 <aDouble>3.1591</aDouble> 24 <aBoolean>true</aBoolean> 25 <aChar>a</aChar> 26 <aWchar>~</aWchar> 27 <aLongLong>9223372036854775798</aLongLong> 28 <aUnsignedLongLong>21</aUnsignedLongLong> 29 <anEnum>ACE</anEnum> 30 <anEnumSeq> 31 <item>KING</item> 32 <item>QUEEN</item> 33 <item>ACE</item> 34 </anEnumSeq> 35 <anEnumArr> 36 <item>ACE</item> 37 <item>QUEEN</item> 38 <item>KING</item> 39 </anEnumArr> 40 </aComplexType> 41 <anEnum>QUEEN</anEnum> 42 <anEnumSeq> 43 <item>KING</item> 44 <item>QUEEN</item> 45 <item>ACE</item> 46 </anEnumSeq> 47 <anEnumArr> 48 <item>ACE</item> 49 <item>QUEEN</item> 50 <item>KING</item> 51 </anEnumArr> 52</sample>
application/dds-web+json1{ 2 "aString": "This is a string!", 3 "aLong": -123456789, 4 "aShort": 125, 5 "anOctet": 255, 6 "aUnsignedShort": 5, 7 "aUnsignedLong": 123456789, 8 "aFloat": 3.75, 9 "aDouble": 3.1591, 10 "aBoolean": false, 11 "aChar": "a", 12 "aWchar": "~", 13 "aLongLong": -9223372036854775798, 14 "aUnsignedLongLong": 9223372036854775798, 15 "anAlias": false, 16 "aComplexType": { 17 "aString": "Another string!", 18 "aLong": -123456789, 19 "aShort": 125, 20 "aUnsignedShort": 5, 21 "aUnsignedLong": 123456789, 22 "aFloat": 3.75, 23 "aDouble": 3.1591, 24 "aBoolean": true, 25 "aChar": "a", 26 "aWchar": "~", 27 "aLongLong": -9223372036854775798, 28 "aUnsignedLongLong": 9223372036854775798, 29 "anEnum": "ACE", 30 "anEnumSeq": [ "KING", "QUEEN", "ACE" ], 31 "anEnumArr": [ "ACE", "QUEEN", "KING" ] 32 }, 33 "anEnum": "QUEEN", 34 "anEnumSeq": [ "KING", "QUEEN" , "ACE" ], 35 "anEnumArr": [ "ACE", "QUEEN", "KING" ] 36}
- 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+xmlorapplication/dds-web+json.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the sample has been written.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
application/dds-web+json1{ 2 "code": "INVALID_INPUT", 3 "message": "Invalid URL" 4}
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
application/dds-web+json1{ 2 "code": "GENERIC_SERVICE_ERROR", 3 "message": "Generic error message" 4}
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the DataWriter has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- PUT /dds/rest1/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:
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.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<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:
Description: If successful, this method returns an empty response body indicating that the Type has been registered.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<register_type_list> 2 <registered_type name="ShapeType"/> 3 <registered_type name="HelloWorldType"/> 4</register_type_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the type has been unregistered.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<subscriber name="subscriberName"/>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the Subscriber has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<subscriber_list> 2 <subscriber name="MySubscriber"/> 3 <subscriber name="YourSubscriber"/> 4</subscriber_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the Subscriber has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- PUT /dds/rest1/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:
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.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<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:
Description: If successful, this method returns an empty response body indicating that the DataReader has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<data_reader_list> 2 <data_reader name="MySquareReader"/> 3 <data_reader name="MyCircleReader"/> 4 <data_reader name="MyTriangleReader"/> 5</data_reader_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the DataReader has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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
sampleFormatparameter can be set to eitherxmlorjson. If unspecified, it defaults toxml.Type:
stringRequired: 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:
booleanRequired: 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:
booleanRequired: 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
removeFromReaderCacheparameter can be set totrueorfalse. If unspecified, it defaults totrue, meaning that the samples are removed from the DataReader’s cache.Type:
booleanRequired: 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:
integerRequired: 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:
integerRequired: 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:
stringRequired: 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:
stringRequired: 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:
stringRequired: 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:
stringRequired: 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+xmlorapplication/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+xmlorapplication/dds-web+json.
- Status Codes:
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-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<read_sample_seq> 2 <sample> 3 <read_sample_info> 4 <source_timestamp> 5 <sec>1456957176</sec> 6 <nanosec>207723000</nanosec> 7 </source_timestamp> 8 <valid_data>true</valid_data> 9 <instance_handle> 10 00000000000000000000000000000000 11 </instance_handle> 12 <instance_state>ALIVE</instance_state> 13 <sample_state>NOT_READ</sample_state> 14 <view_state>NEW</view_state> 15 </read_sample_info> 16 <data> 17 <aString>This is a string!</aString> 18 <aLong>-123456789</aLong> 19 <aShort>125</aShort> 20 <anOctet>255</anOctet> 21 <aUnsignedShort>5</aUnsignedShort> 22 <aUnsignedLong>123456789</aUnsignedLong> 23 <aFloat>3.75</aFloat> 24 <aDouble>3.1591</aDouble> 25 <aBoolean>false</aBoolean> 26 <aChar>a</aChar> 27 <aWchar>~</aWchar> 28 <aLongLong>-9223372036854775798</aLongLong> 29 <aUnsignedLongLong>14</aUnsignedLongLong> 30 <anAlias>false</anAlias> 31 <aComplexType> 32 <aString>Another string!</aString> 33 <aLong>-123456789</aLong> 34 <aShort>125</aShort> 35 <aUnsignedShort>5</aUnsignedShort> 36 <aUnsignedLong>123456789</aUnsignedLong> 37 <aFloat>3.75</aFloat> 38 <aDouble>3.1591</aDouble> 39 <aBoolean>true</aBoolean> 40 <aChar> a</aChar> 41 <aWchar>~</aWchar> 42 <aLongLong>9223372036854775798</aLongLong> 43 <aUnsignedLongLong>21</aUnsignedLongLong> 44 <anEnum>ACE</anEnum> 45 <anEnumSeq> 46 <item>KING</item> 47 <item>QUEEN</item> 48 <item>ACE</item> 49 </anEnumSeq> 50 <anEnumArr> 51 <item>ACE</item> 52 <item>QUEEN</item> 53 <item>KING</item> 54 </anEnumArr> 55 </aComplexType> 56 <anEnum>QUEEN</anEnum> 57 <anEnumSeq> 58 <item>KING</item> 59 <item>QUEEN</item> 60 <item>ACE</item> 61 </anEnumSeq> 62 <anEnumArr> 63 <item>ACE</item> 64 <item>QUEEN</item> 65 <item>KING</item> 66 </anEnumArr> 67 </data> 68 </sample> 69</read_sample_seq>
application/dds-web+json1[ 2 { 3 "read_sample_info":{ 4 "source_timestamp":{ 5 "sec":1456962954, 6 "nanosec":150101000 7 }, 8 "valid_data":true, 9 "instance_handle":"00000000000000000000000000000000", 10 "instance_state":"ALIVE", 11 "sample_state":"NOT_READ", 12 "view_state":"NEW" 13 }, 14 "data":{ 15 "aString":"This is a string!", 16 "aUnion":{ 17 "aLongUnion":10 18 }, 19 "aLong":-123456789, 20 "aShort":125, 21 "anOctet":255, 22 "aUnsignedShort":5, 23 "aUnsignedLong":123456789, 24 "aFloat":3.75, 25 "aDouble":3.1591, 26 "aBoolean":false, 27 "aChar":"a", 28 "aWchar":"~", 29 "aLongLong":-9223372036854775798, 30 "aUnsignedLongLong":9223372036854775798, 31 "anAlias":false, 32 "aComplexType":{ 33 "aString":"Another string!", 34 "aUnionI":{ 35 "aLongUnion":10 36 }, 37 "aLong":-123456789, 38 "aShort":125, 39 "aUnsignedShort":5, 40 "aUnsignedLong":123456789, 41 "aFloat":3.75, 42 "aDouble":3.1591, 43 "aBoolean":true, 44 "aChar":"a", 45 "aWchar":"~", 46 "aLongLong":-9223372036854775798, 47 "aUnsignedLongLong":9223372036854775798, 48 "anEnum":"ACE", 49 "anEnumSeq":["KING","QUEEN","ACE"], 50 "anEnumArr":["ACE","QUEEN","KING"] 51 }, 52 "anEnum":"QUEEN", 53 "anEnumSeq":["KING","QUEEN","ACE"], 54 "anEnumArr":["ACE","QUEEN","KING"] 55 } 56 } 57]
Description: In case of error in DDS’ read or take operation, this method returns a response body with the error code
INVALID_OBJECTand a message describing the error. Depending on thesampleFormatof the request, theContent-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<error> 2 <code>INVALID_OBJECT</code> 3 <message>Error message</message> 4</error>
application/dds-web+json1{ 2 "code": "INVALID_OBJECT", 3 "message": "Error message" 4}
Description: In case of an invalid input this method returns a response body with the error code and a message. Depending on the
sampleFormatof the request, theContent-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<error>,12,1 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
application/dds-web+json1{ 2 "code": "INVALID_INPUT", 3 "message": "Invalid URL" 4}
Description: DDS error or generic server error. Depending on the sampleFormat indicated in the request, the
Content-Typeof the response will beapplication/dds-web+xmlorapplication/dds-web+json.Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
application/dds-web+json1{ 2 "code": "GENERIC_SERVICE_ERROR", 3 "message": "Generic error message" 4}
- PUT /dds/rest1/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:
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.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<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:
Description: If successful, this method returns an empty response body indicating that the Topic has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<topic_list> 2 <topic name="Square"/> 3 <topic name="Triangle"/> 4</topic_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the Topic has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- PUT /dds/rest1/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:
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.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<domain_library name="MyDomainLibrary"> 2 <domain name="ShapeDomain" domain_id="0"> 3 <register_type name="ShapeType" type_ref="ShapeType"/> 4 <topic name="Square" register_type_ref="ShapeType" /> 5 <topic name="Circle" register_type_ref="ShapeType" /> 6 <topic name="Triangle" register_type_ref="ShapeType" /> 7 </domain> 8</domain_library>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the Domain Library has been created.
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+xml1 <error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4 </error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<domain_library_list> 2 <domain_library name="aDomainLibrary"/> 3 <domain_library name="anotherDomainLibrary"/> 4</domain_library_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the Domain Library has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<qos_library name="qosLibrary"> 2 <qos_profile name="defaultProfile" is_default_qos="true"> 3 <domain_participant_qos> 4 <resource_limits> 5 <type_code_max_serialized_length> 6 32000 7 </type_code_max_serialized_length> 8 <type_object_max_serialized_length> 9 32000 10 </type_object_max_serialized_length> 11 </resource_limits> 12 </domain_participant_qos> 13 </qos_profile> 14</qos_library>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the QoS Library has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<qos_library_list> 2 <qos_library name="qosLibrary"> 3 <qos_profile name="myProfile"> 4 <!-- ... --> 5 </qos_profile> 6 </qos_library> 7 <qos_library name ="anotherQosLibrary"> 8 <qos_profile name="anotherQosProfile"> 9 <!-- ... --> 10 </qos_profile> 11 </qos_library> 12</qos_library_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the QoS Library has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<qos_profile name="defaultProfile" is_default_qos="true"> 2 <domain_participant_qos> 3 <resource_limits> 4 <type_code_max_serialized_length> 5 32000 6 </type_code_max_serialized_length> 7 <type_object_max_serialized_length> 8 32000 9 </type_object_max_serialized_length> 10 </resource_limits> 11 </domain_participant_qos> 12</qos_profile>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the QoS Profile has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<qos_profile_list> 2 <qos_profile name="myProfile"> 3 <!-- ... --> 4 <qos_profile name="anotherQosProfile"> 5 <!-- ... --> 6 </qos_profile> 7</qos_profile_list>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the QoS Profile has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- POST /dds/rest1/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+xml1<types> 2 <const name="MAX_COLOR_LEN" type="long" value="128"/> 3 <struct name="ShapeType"> 4 <member name="color" type="string" stringMaxLength="128" key="true"/> 5 <member name="x" type="long"/> 6 <member name="y" type="long"/> 7 <member name="shapesize" type="long"/> 8 </struct> 9</types>
- Response Headers:
Content-Length – Transfer-length of the message-body.
Content-Type – Valid values:
application/dds-web+xml.
- Status Codes:
Description: If successful, this method returns an empty response body indicating that the type has been created.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- GET /dds/rest1/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+xml1<types> 2 <const name="MAX_COLOR_LEN" type="long" value="128"/> 3 <struct name="ShapeType"> 4 <member name="color" type="string" stringMaxLength="128" key="true"/> 5 <member name="x" type="long"/> 6 <member name="y" type="long"/> 7 <member name="shapesize" type="long"/> 8 </struct> 9</types>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>
- DELETE /dds/rest1/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:
Description: If successful, this method returns an empty response body indicating that the type has been deleted.
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+xml1<error> 2 <code>INVALID_INPUT</code> 3 <message>Invalid URL</message> 4</error>
Description: DDS error or generic server error.
Example Response Body:
application/dds-web+xml1<error> 2 <code>GENERIC_SERVICE_ERROR</code> 3 <message>Generic error message</message> 4</error>