are not inspected for content.\r
\r
\r
-+-------------------------+----------------------------------------------------------------------------------------------------------------+\r
-| Content-Type | Description |\r
-+=========================+================================================================================================================+\r
-| text/plain | Each line in the POST body is treated as a separate message. No partition key is specified, and therefore no |\r
-| | order is guaranteed. This format is mainly for test, as messages are highly likely to be re-ordered when |\r
-| | delivered through the Kafka cluster. |\r
-+-------------------------+----------------------------------------------------------------------------------------------------------------+\r
-| application/json | The payload maybe a single JSON object or a JSON array of JSON objects. Each object is handled as an individual|\r
-| | message..Note that use of this format may result in equivalent but altered JSON objects sent to consumers. | \r
-| | That's because MR uses a standard JSON parser to read each object into memory before pushing the object to the |\r
-| | Kafka system. At that point, the JSON object is re-written from the in-memory object. This can result in |\r
-| | re-ordered fields or changes in whitespace. If you want to preseve JSON objects exactly, |\r
-| | use application/cambria. Recommended to follow the JSON format after validating the |\r
-| | message in https://jsonformatter.curiousconcept.com/ |\r
-+-------------------------+----------------------------------------------------------------------------------------------------------------+\r
++-------------------------+-----------------------------------------------------------------------------------------------------------------+\r
+| Content-Type | Description |\r
++=========================+=================================================================================================================+\r
+| text/plain | Each line in the POST body is treated as a separate message. No partition key is specified, and therefore no |\r
+| | order is guaranteed. This format is mainly for test, as messages are highly likely to be re-ordered when |\r
+| | delivered through the Kafka cluster. |\r
++-------------------------+-----------------------------------------------------------------------------------------------------------------+\r
+| application/json | The payload maybe a single JSON object or a JSON array of JSON objects. Each object is handled as an individual |\r
+| | message..Note that use of this format may result in equivalent but altered JSON objects sent to consumers. | \r
+| | That's because MR uses a standard JSON parser to read each object into memory before pushing the object to the |\r
+| | Kafka system. At that point, the JSON object is re-written from the in-memory object. This can result in |\r
+| | re-ordered fields or changes in whitespace. If you want to preseve JSON objects exactly, |\r
+| | use application/cambria. Recommended to follow the JSON format after validating the |\r
+| | message in https://jsonformatter.curiousconcept.com/ |\r
++-------------------------+-----------------------------------------------------------------------------------------------------------------+\r
\r
Publishers\r
-----------\r
Request Parameters:\r
===================\r
\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-| Name | Description | Param Type | data type | MaxLen | Required | Format | Valid/Example Values |\r
-+=============+=================================+==================+============+==============+=============+=============+==========================+\r
-|Topicname | topic name to be posted | Path | String | 40 | Y | namespace. | |\r
-| | | | | | | String | |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-|Consumer | A name that uniquely identifies | Path | String | | Y | | CG1 |\r
-|group | your subscribers | | | | | | |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-|consumerId | Within your subscribers group, | Path | String | | Y | | C1 |\r
-| | a name that uniquely identifies | | | | | | |\r
-| | your subscribers process | | | | | | | +-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-|content-type | To specify type of message | Header | String | 20 | N | | aplication/json |\r
-| | content(json,text or cambria) | | | | | | |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-|Username | userid | Header | String | 1 | N | | |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
-|Password | | Header | String | 1 | N | | |\r
-+-------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+ \r
++--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
+| Name | Description | Param Type | data type | MaxLen | Required | Format | Valid/Example Values |\r
++==============+=================================+==================+============+==============+=============+=============+==========================+\r
+| Topicname | topic name to be posted | Path | String | 40 | Y | namespace. | |\r
+| | | | | | | String | |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
+| Consumer | A name that uniquely identifies | Path | String | | Y | | CG1 |\r
+| group | your subscribers | | | | | | |\r
++------------- +---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
+| consumerId | Within your subscribers group, | Path | String | | Y | | C1 |\r
+| | a name that uniquely identifies | | | | | | |\r
+| | your subscribers process | | | | | | | +--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
+| content-type | To specify type of message | Header | String | 20 | N | | aplication/json |\r
+| | content(json,text or cambria) | | | | | | |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
+| Username | userid | Header | String | 1 | N | | |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+\r
+| Password | | Header | String | 1 | N | | |\r
++--------------+---------------------------------+------------------+------------+--------------+-------------+-------------+--------------------------+ \r
\r
**NOTE1**:Subscribers /user should have access on the topics. The user () and\r
permissions details needs to be in AAF.\r
| DMaaP\_MR\_ERR\_5012 | 429 | Too many requests | This client is making too many requests. Please use a long poll setting to decrease the | \r
| | | | number of requests that result in empty responses. |\r
+-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
-| | 503 | Service Unavailable | Service Unavailable | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
+| | 503 | Service Unavailable | Service Unavailable. | +-------------------------+-----------------+----------------------------+---------------------------------------------------------------------------------------------+\r
\r
Sample Request:\r
===============\r
Request Parameters:\r
===================\r
\r
-+-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
-| Name | Description | Param Type | datatype | MaxLen | Required | Format | Valid/Example Values |\r
-+=================+=================================+==================+============+==============+=============+=============+===================================+\r
-| Topicname | topicname to be created in MR | Body | String | 20 | Y | Json | com.att.dmaap.mr.metrics |\r
-+-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|topicDescription | description for topic | Body | String | 15 | Y | | |\r
-+-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|partitionCount | Kafka topic partition | Body | String | 1 | Y | | |\r
-+-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|replicationCount | Kafka topic replication | Body | String | 1 | Y | | 3 (Default -for 3 node Kafka ) |\r
-+-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|transaction |to create transaction id for | Body | Boolean | 1 | N | | true |\r
-| Enabled | each message transaction | | | | | | |\r
-+-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
-|Content-Type | application/json | Header | String | | | | application/json |\r
-+-----------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
++-------------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
+| Name | Description | Param Type | datatype | MaxLen | Required | Format | Valid/Example Values |\r
++===================+=================================+==================+============+==============+=============+=============+===================================+\r
+| Topicname | topicname to be created in MR | Body | String | 20 | Y | Json | com.att.dmaap.mr.metrics |\r
++-------------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+| topicDescription | description for topic | Body | String | 15 | Y | | |\r
++-------------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+| partitionCount | Kafka topic partition | Body | String | 1 | Y | | |\r
++-------------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+| replicationCount | Kafka topic replication | Body | String | 1 | Y | | 3 (Default -for 3 node Kafka ) |\r
++-------------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+| transaction | to create transaction id for | Body | Boolean | 1 | N | | true |\r
+| Enabled | each message transaction | | | | | | |\r
++-------------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+ \r
+| Content-Type | application/json | Header | String | | | | application/json |\r
++-------------------+---------------------------------+------------------+------------+--------------+-------------+-------------+-----------------------------------+\r
\r
+---------------------------+------------------------------------+\r
| Response statusCode | Response statusMessage |\r
API Inventory\r
------------- \r
\r
-+-----------+-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
-| | API Name | API Method | REST API Path | | Comments |\r
-+===========+===================+=========================================+=======================================+================+==================================+\r
-| Topics | GetAll Topics |getTopics() |/topics |GET | |\r
-| |List | | | | |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
-| | Get All Topics | | | | |\r
-| |List with details | getAllTopics() | /topics/listAll | GET | |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
-| | Get individual | | | | |\r
-| | Topic Details | getTopic(String topicName) | /topics/{topicName} | GET | |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
-| | Create Topic | createTopic(TopicBean topicBean) | /topics/create | POST | |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
-| | Delete Topic | deleteTopicString topicName) | /topics/{topicName} | DELETE | Not used in current MR version |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
-| | Get Publishers | getPublishersByTopicName | | | |\r
-| | for a Topic | (String topicName) | /topics/{topicName}/producers | GET | UEB Backward Compatibility |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
-| | Add a Publisher |permitPublisherForTopic | /topics/{topicName}/producers/ | PUT | |\r
-| |to write ACLon |(String topicName, String producerId) | {producerId} | | |\r
-| |a Topic | | | | |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
-| |Remove a Publisher |denyPublisherForTopic(String topicName,|/topics/{topicName}/producers/ | | | \r
-| |from write ACL on |String producerId) |{producerId} | DELETE | |\r
-| | a Topic | | | | |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
-| |Get Consumers for | getConsumersByTopicName | /topics/{topicName}/consumers | GET | |\r
-| | a Topic | (String topicName) | | | |\r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
-| | Add a Consumer | permitConsumerForTopic(String topicName,| /topics/{topicName}/consumers/ | PUT | |\r
-| |to read ACL | String consumerId) | {consumerId} | | |\r
-| |on a Topic | | | | | \r
-| +-------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
-| | Remove a consumer |denyPublisherForTopic(String topicName,|/topics/{topicName}/consumers/ | | | \r
-| |from write |String consumerId) |{consumerId} | | |\r
-| | ACL on a Topic | | | DELETE | |\r
-+-----------+-------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
++-----------+--------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
+| | API Name | API Method | REST API Path | | Comments |\r
++===========+====================+=========================================+=======================================+================+==================================+\r
+| Topics | GetAll Topics | getTopics() | /topics | GET | |\r
+| | List | | | | |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
+| | Get All Topics | | | | |\r
+| | List with details | getAllTopics() | /topics/listAll | GET | |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
+| | Get individual | | | | |\r
+| | Topic Details | getTopic(String topicName) | /topics/{topicName} | GET | |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
+| | Create Topic | createTopic(TopicBean topicBean) | /topics/create | POST | |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
+| | Delete Topic | deleteTopicString topicName) | /topics/{topicName} | DELETE | Not used in current MR version |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r
+| | Get Publishers | getPublishersByTopicName | | | |\r
+| | for a Topic | String topicName) | /topics/{topicName}/producers | GET | UEB Backward Compatibility |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
+| | Add a Publisher | permitPublisherForTopic | /topics/{topicName}/producers/ | PUT | |\r
+| | to write ACLon | (String topicName, String producerId) | {producerId} | | |\r
+| | a Topic | | | | |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
+| | Remove a Publisher | denyPublisherForTopic(String topicName, | /topics/{topicName}/producers/ | DELETE | | \r
+| | from write ACL on | String producerId) | {producerId} | | |\r
+| | a Topic | | | | |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
+| | Get Consumers for | getConsumersByTopicName | /topics/{topicName}/consumers | GET | |\r
+| | a Topic | (String topicName) | | | |\r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
+| | Add a Consumer | permitConsumerForTopic(String | /topics/{topicName}/consumers/ | PUT | |\r
+| | to read ACL | topicName,String consumerId) | {consumerId} | | |\r
+| | on a Topic | | | | | \r
+| +--------------------+-----------------------------------------+---------------------------------------+----------------+ |\r
+| | Remove a consumer | denyPublisherForTopic(String topicName, | /topics/{topicName}/consumers/ | DELETE | | \r
+| | from write | String consumerId) | {consumerId} | | |\r
+| | ACL on a Topic | | | | |\r
++-----------+--------------------+-----------------------------------------+---------------------------------------+----------------+----------------------------------+\r