Sample Request\r
==============\r
\r
-``curl -k -X POST -H "Content-Type:application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF:{user}" --data-ascii @createFeed.json https://{host}:{port}``\r
+``curl -k -X POST -H "Content-Type:application/vnd.dmaap-dr.feed" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @createFeed.json https://{host}:{port}``\r
\r
Request Parameters:\r
===================\r
| group-id | | Body | Integer | | Y | |\r
| | | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | | Y | application/vnd.att-dr.feed |\r
+| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.feed |\r
| | (feed,subscriber,publisher) | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | <=8 | Y | username |\r
+| X-DMAAP-DR-ON-BEHALF-OF| User id of owner of feed | Header | String | <=8 | Y | username |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @updateFeed.json --location-trusted https://{host}:{port}/feed/{feedId}``\r
+``curl -k -X PUT -H "Content-Type: application/vnd.dmaap-dr.feed" -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" --data-ascii @updateFeed.json --location-trusted https://{host}:{port}/feed/{feedId}``\r
\r
Request Parameters:\r
===================\r
| group-id | | Body | Integer | | Y | |\r
| | | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | | Y | application/vnd.att-dr.feed |\r
+| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.feed |\r
| | (feed,subscriber,publisher) | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | <=8 | Y | username |\r
+| X-DMAAP-DR-ON-BEHALF-OF| User id of owner of feed | Header | String | <=8 | Y | username |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -H "X-ATT-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}``\r
+``curl -k -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}``\r
\r
Response/Error Codes\r
====================\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}``\r
+``curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}``\r
\r
Response/Error Codes\r
====================\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -X POST -H "Content-Type:application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF:{user}" --data-ascii @addSubscriber.json https://{host}:{port}/subscribe/{feedId}``\r
+``curl -k -X POST -H "Content-Type:application/vnd.dmaap-dr.subscription" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @addSubscriber.json https://{host}:{port}/subscribe/{feedId}``\r
\r
Request Parameters:\r
===================\r
| group-id | | Body | Integer | | Y | |\r
| | | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | | Y | application/vnd.att-dr.subscription |\r
+| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.subscription|\r
| | (feed,subscriber,publisher) | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | <=8 | Y | username |\r
+| X-DMAAP-DR-ON-BEHALF-OF| User id of subscriber | Header | String | <=8 | Y | username |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -X PUT -H "Content-Type:application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF:{user}" --data-ascii @updateSubscriber.json https://{host}:{port}/subs/{subId}``\r
+``curl -k -X PUT -H "Content-Type:application/vnd.dmaap-dr.subscription" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @updateSubscriber.json https://{host}:{port}/subs/{subId}``\r
\r
Request Parameters:\r
===================\r
| group-id | | Body | Integer | | Y | |\r
| | | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | | Y | application/vnd.att-dr.subscription |\r
+| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.subscription|\r
| | (feed,subscriber,publisher) | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 8 | Y | username |\r
+| X-DMAAP-DR-ON-BEHALF-OF| User id of subscriber | Header | String | 8 | Y | username |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -H "X-ATT-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}``\r
+``curl -k -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}``\r
\r
Response/Error Codes\r
====================\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -X DELETE -H "X-ATT-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}``\r
+``curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}``\r
\r
Response/Error Codes\r
====================\r
| | IP address |\r
| | * Client certificate subject is not on |\r
| | the API’s authorized list. |\r
-| | * X-ATT-DR-ON-BEHALF-OF identity is not |\r
+| | * X-DMAAP-DR-ON-BEHALF-OF identity is not |\r
| | authorized to perform |\r
+------------------------+-------------------------------------------+\r
| 404 | Not Found - The Request-URI does not point|\r
Sample Request\r
==============\r
\r
-``curl -k -X PUT --user {user}:{password} -H "Content-Type:application/octet-stream" -H "X-ATT-DR-META:{\"filetype\":\"txt\"}" --data-binary @sampleFile.txt --post301 --location-trusted https://{host}:{port}/publish/{feedId}/sampleFile``\r
+``curl -k -X PUT --user {user}:{password} -H "Content-Type:application/octet-stream" -H "X-DMAAP-DR-META:{\"filetype\":\"txt\"}" --data-binary @sampleFile.txt --post301 --location-trusted https://{host}:{port}/publish/{feedId}/sampleFile``\r
\r
Request parameters\r
==================\r
| content-type | To specify type of message | Header | String | | Y | application/octet-stream |\r
| | format | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
-| X-ATT-DR-META | Metadata for the file. Accepts | Header | String | 4096 | N | '{"compressionType":"gzip","id": 1234, "transferred":true, "size":null}' |\r
+| X-DMAAP-DR-META | Metadata for the file. Accepts | Header | String | 4096 | N | '{"compressionType":"gzip","id": 1234, "transferred":true, "size":null}' |\r
| | only non nested json objects | | | | | |\r
| | of the following type : | | | | | |\r
| | -Numbers | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
| publishId | Select records with specified | Path | String | | N | |\r
| | publish id, carried in the | | | | | |\r
-| | X-ATT-DR-PUBLISH-ID header from | | | | | |\r
-| | original publish request | | | | | |\r
+| | X-DMAAP-DR-PUBLISH-ID header | | | | | |\r
+| | from original publish request | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
| start | Select records created at or | Path | String | | N | A date-time expressed in the format |\r
| | after specified date | | | | | specified by RFC 3339 |\r
Response Parameters\r
===================\r
\r
-+------------------------+-------------------------------------------+\r
-| Name | Description |\r
-+========================+===========================================+\r
-| type | Record type: |\r
-| | |\r
-| | * pub: publication attempt |\r
-| | * del: delivery attempt |\r
-| | * exp: delivery expiry |\r
-+------------------------+-------------------------------------------+\r
-| date | The UTC date and time at which the record |\r
-| | was generated, with millisecond resolution|\r
-| | in the format specified by RFC 3339 |\r
-+------------------------+-------------------------------------------+\r
-| publishId | The unique identifier assigned by the DR |\r
-| | at the time of the initial publication |\r
-| | request (carried in the X-ATT-DRPUBLISH-ID|\r
-| | header in the response to the original |\r
-| | publish request) |\r
-+------------------------+-------------------------------------------+\r
-| requestURI | The Request-URI associated with the |\r
-| | request |\r
-+------------------------+-------------------------------------------+\r
-| method | The HTTP method (PUT or DELETE) for the |\r
-| | request |\r
-+------------------------+-------------------------------------------+\r
-| contentType | The media type of the payload of the |\r
-| | request |\r
-+------------------------+-------------------------------------------+\r
-| contentLength | The size (in bytes) of the payload of |\r
-| | the request |\r
-+------------------------+-------------------------------------------+\r
-| sourceIp | The IP address from which the request |\r
-| | originated |\r
-+------------------------+-------------------------------------------+\r
-| endpointId | The identity used to submit a publish |\r
-| | request to the DR |\r
-+------------------------+-------------------------------------------+\r
-| deliveryId | The identity used to submit a delivery |\r
-| | request to a subscriber endpoint |\r
-+------------------------+-------------------------------------------+\r
-| statusCode | The HTTP status code in the response to |\r
-| | the request. A value of -1 indicates that |\r
-| | the DR was not able to obtain an HTTP |\r
-| | status code |\r
-+------------------------+-------------------------------------------+\r
-| expiryReason | The reason that delivery attempts were |\r
-| | discontinued: |\r
-| | |\r
-| | * notRetryable: The last delivery attempt |\r
-| | encountered an error condition for which|\r
-| | the DR does not make retries. |\r
-| | * retriesExhausted: The DR reached its |\r
-| | limit for making further retry attempts |\r
-+------------------------+-------------------------------------------+\r
-| attempts | Total number of attempts made before |\r
-| | delivery attempts were discontinued |\r
-+------------------------+-------------------------------------------+\r
++------------------------+----------------------------------------------+\r
+| Name | Description |\r
++========================+==============================================+\r
+| type | Record type: |\r
+| | |\r
+| | * pub: publication attempt |\r
+| | * del: delivery attempt |\r
+| | * exp: delivery expiry |\r
++------------------------+----------------------------------------------+\r
+| date | The UTC date and time at which the record |\r
+| | was generated, with millisecond resolution |\r
+| | in the format specified by RFC 3339 |\r
++------------------------+----------------------------------------------+\r
+| publishId | The unique identifier assigned by the DR |\r
+| | at the time of the initial publication |\r
+| | request (carried in the X-DMAAP-DR-PUBLISH-ID|\r
+| | header in the response to the original |\r
+| | publish request) |\r
++------------------------+----------------------------------------------+\r
+| requestURI | The Request-URI associated with the |\r
+| | request |\r
++------------------------+----------------------------------------------+\r
+| method | The HTTP method (PUT or DELETE) for the |\r
+| | request |\r
++------------------------+----------------------------------------------+\r
+| contentType | The media type of the payload of the |\r
+| | request |\r
++------------------------+----------------------------------------------+\r
+| contentLength | The size (in bytes) of the payload of |\r
+| | the request |\r
++------------------------+----------------------------------------------+\r
+| sourceIp | The IP address from which the request |\r
+| | originated |\r
++------------------------+----------------------------------------------+\r
+| endpointId | The identity used to submit a publish |\r
+| | request to the DR |\r
++------------------------+----------------------------------------------+\r
+| deliveryId | The identity used to submit a delivery |\r
+| | request to a subscriber endpoint |\r
++------------------------+----------------------------------------------+\r
+| statusCode | The HTTP status code in the response to |\r
+| | the request. A value of -1 indicates that |\r
+| | the DR was not able to obtain an HTTP |\r
+| | status code |\r
++------------------------+----------------------------------------------+\r
+| expiryReason | The reason that delivery attempts were |\r
+| | discontinued: |\r
+| | |\r
+| | * notRetryable: The last delivery attempt |\r
+| | encountered an error condition for which |\r
+| | the DR does not make retries. |\r
+| | * retriesExhausted: The DR reached its |\r
+| | limit for making further retry attempts |\r
++------------------------+----------------------------------------------+\r
+| attempts | Total number of attempts made before |\r
+| | delivery attempts were discontinued |\r
++------------------------+----------------------------------------------+\r
\r
Response/Error Codes\r
====================\r
| 406 | Not Acceptable - The request has an Accept|\r
| | header indicating that the requester will |\r
| | not accept a response with |\r
-| | application/vnd.att-dr.log-list content. |\r
+| | application/vnd.dmaap-dr.log-list content.|\r
+------------------------+-------------------------------------------+\r
| 500 | Internal Server Error - The DR API server |\r
| | encountered an internal error and could |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
| publishId | Select records with specified | Path | String | | N | |\r
| | publish id, carried in the | | | | | |\r
-| | X-ATT-DR-PUBLISH-ID header from | | | | | |\r
-| | original publish request | | | | | |\r
+| | X-DMAAP-DR-PUBLISH-ID header | | | | | |\r
+| | from original publish request | | | | | |\r
+------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
| start | Select records created at or | Path | String | | N | A date-time expressed in the format |\r
| | after specified date | | | | | specified by RFC 3339 |\r
Response Parameters\r
===================\r
\r
-+------------------------+-------------------------------------------+\r
-| Name | Description |\r
-+========================+===========================================+\r
-| type | Record type: |\r
-| | |\r
-| | * pub: publication attempt |\r
-| | * del: delivery attempt |\r
-| | * exp: delivery expiry |\r
-+------------------------+-------------------------------------------+\r
-| date | The UTC date and time at which the record |\r
-| | was generated, with millisecond resolution|\r
-| | in the format specified by RFC 3339 |\r
-+------------------------+-------------------------------------------+\r
-| publishId | The unique identifier assigned by the DR |\r
-| | at the time of the initial publication |\r
-| | request(carried in the X-ATT-DR-PUBLISH-ID|\r
-| | header in the response to the original |\r
-| | publish request) to a feed log URL or |\r
-| | subscription log URL known to the system |\r
-+------------------------+-------------------------------------------+\r
-| requestURI | The Request-URI associated with the |\r
-| | request |\r
-+------------------------+-------------------------------------------+\r
-| method | The HTTP method (PUT or DELETE) for the |\r
-| | request |\r
-+------------------------+-------------------------------------------+\r
-| contentType | The media type of the payload of the |\r
-| | request |\r
-+------------------------+-------------------------------------------+\r
-| contentLength | The size (in bytes) of the payload of |\r
-| | the request |\r
-+------------------------+-------------------------------------------+\r
-| sourceIp | The IP address from which the request |\r
-| | originated |\r
-+------------------------+-------------------------------------------+\r
-| endpointId | The identity used to submit a publish |\r
-| | request to the DR |\r
-+------------------------+-------------------------------------------+\r
-| deliveryId | The identity used to submit a delivery |\r
-| | request to a subscriber endpoint |\r
-+------------------------+-------------------------------------------+\r
-| statusCode | The HTTP status code in the response to |\r
-| | the request. A value of -1 indicates that |\r
-| | the DR was not able to obtain an HTTP |\r
-| | status code |\r
-+------------------------+-------------------------------------------+\r
-| expiryReason | The reason that delivery attempts were |\r
-| | discontinued: |\r
-| | |\r
-| | * notRetryable: The last delivery attempt |\r
-| | encountered an error condition for which|\r
-| | the DR does not make retries. |\r
-| | * retriesExhausted: The DR reached its |\r
-| | limit for making further retry attempts |\r
-+------------------------+-------------------------------------------+\r
-| attempts | Total number of attempts made before |\r
-| | delivery attempts were discontinued |\r
-+------------------------+-------------------------------------------+\r
++------------------------+---------------------------------------------+\r
+| Name | Description |\r
++========================+=============================================+\r
+| type | Record type: |\r
+| | |\r
+| | * pub: publication attempt |\r
+| | * del: delivery attempt |\r
+| | * exp: delivery expiry |\r
++------------------------+---------------------------------------------+\r
+| date | The UTC date and time at which the record |\r
+| | was generated, with millisecond resolution |\r
+| | in the format specified by RFC 3339 |\r
++------------------------+---------------------------------------------+\r
+| publishId | The unique identifier assigned by the DR |\r
+| | at the time of the initial publication |\r
+| | request(carried in the X-DMAAP-DR-PUBLISH-ID|\r
+| | header in the response to the original |\r
+| | publish request) to a feed log URL or |\r
+| | subscription log URL known to the system |\r
++------------------------+---------------------------------------------+\r
+| requestURI | The Request-URI associated with the |\r
+| | request |\r
++------------------------+---------------------------------------------+\r
+| method | The HTTP method (PUT or DELETE) for the |\r
+| | request |\r
++------------------------+---------------------------------------------+\r
+| contentType | The media type of the payload of the |\r
+| | request |\r
++------------------------+---------------------------------------------+\r
+| contentLength | The size (in bytes) of the payload of |\r
+| | the request |\r
++------------------------+---------------------------------------------+\r
+| sourceIp | The IP address from which the request |\r
+| | originated |\r
++------------------------+---------------------------------------------+\r
+| endpointId | The identity used to submit a publish |\r
+| | request to the DR |\r
++------------------------+---------------------------------------------+\r
+| deliveryId | The identity used to submit a delivery |\r
+| | request to a subscriber endpoint |\r
++------------------------+---------------------------------------------+\r
+| statusCode | The HTTP status code in the response to |\r
+| | the request. A value of -1 indicates that |\r
+| | the DR was not able to obtain an HTTP |\r
+| | status code |\r
++------------------------+---------------------------------------------+\r
+| expiryReason | The reason that delivery attempts were |\r
+| | discontinued: |\r
+| | |\r
+| | * notRetryable: The last delivery attempt |\r
+| | encountered an error condition for which |\r
+| | the DR does not make retries. |\r
+| | * retriesExhausted: The DR reached its |\r
+| | limit for making further retry attempts |\r
++------------------------+---------------------------------------------+\r
+| attempts | Total number of attempts made before |\r
+| | delivery attempts were discontinued |\r
++------------------------+---------------------------------------------+\r
\r
Response/Error Codes\r
====================\r
| 406 | Not Acceptable - The request has an Accept|\r
| | header indicating that the requester will |\r
| | not accept a response with |\r
-| | application/vnd.att-dr.log-list content. |\r
+| | application/vnd.dmaap-dr.log-list content.|\r
+------------------------+-------------------------------------------+\r
| 500 | Internal Server Error - The DR API server |\r
| | encountered an internal error and could |\r
Code Review / dmaap / datarouter.git / blobdiff