Sample Request\r
==============\r
\r
-curl -v -X POST -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https:/{host}:{port}\r
+``curl -v -X POST -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https:/{host}:{port}``\r
\r
Request Parameters:\r
===================\r
\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| name | Feed name | Body | String | <=20 | Y | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| version | Feed version | Body | String | <=20 | Y | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| description | Feed description | Body | String | | Y | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| business description | Business description | Body | String | | Y | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Authorization | Information for authorizing | Body | Object | | Y | | |\r
-| | publishing requests | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend | Set to true if the feed is in | Body | Boolean | | N | | * true |\r
-| | the suspended state | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id | | Body | Integer | | Y | | |\r
-| | | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.feed |\r
-| | (feed,subscriber,publisher) | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 1 | N | | username |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| name | Feed name | Body | String | <=20 | Y | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| version | Feed version | Body | String | <=20 | Y | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| description | Feed description | Body | String | <=256 | Y | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| business description | Business description | Body | String | <=256 | Y | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Authorization | Information for authorizing | Body | Object | | Y | |\r
+| | publishing requests | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend | Set to true if the feed is in | Body | Boolean | | N | * true |\r
+| | the suspended state | | | | | * false |\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
+| | (feed,subscriber,publisher) | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 8 | Y | username |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
====================\r
]\r
},\r
\r
-}\r
+ }\r
\r
Updating a Feed\r
---------------\r
Sample Request\r
==============\r
\r
-curl -v -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --location-trusted -k https:/{host}:{port}\r
+``curl -v -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --location-trusted -k https:/{host}:{port}``\r
\r
Request Parameters:\r
===================\r
\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| description | Feed description | Body | String | | Y | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| business description | Business description | Body | String | | Y | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Authorization | Information for authorizing | Body | Object | | Y | | |\r
-| | publishing requests | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend | Set to true if the feed is in | Body | Boolean | | N | | * true |\r
-| | the suspended state | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id | | Body | Integer | | Y | | |\r
-| | | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.feed |\r
-| | (feed,subscriber,publisher) | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 1 | N | | username |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| description | Feed description | Body | String | <=256 | Y | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| business description | Business description | Body | String | <=256 | Y | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Authorization | Information for authorizing | Body | Object | | Y | |\r
+| | publishing requests | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend | Set to true if the feed is in | Body | Boolean | | N | * true |\r
+| | the suspended state | | | | | * false |\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
+| | (feed,subscriber,publisher) | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 8 | Y | username |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
====================\r
]\r
},\r
\r
-}\r
+ }\r
\r
Get a Feed\r
----------\r
Sample Request\r
==============\r
\r
-curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}\r
+``curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}``\r
\r
Response/Error Codes\r
====================\r
Sample Request\r
==============\r
\r
-curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}\r
+``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId}``\r
\r
Response/Error Codes\r
====================\r
Sample Request\r
==============\r
\r
-curl -v -X POST -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --post301 --location-trusted -k https://{host}:{port}/subscribe/{feedId}\r
+``curl -v -X POST -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --post301 --location-trusted -k https://{host}:{port}/subscribe/{feedId}``\r
\r
Request Parameters:\r
===================\r
\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId | ID for the feed you are | Path | String | | Y | | |\r
-| | subscribing to | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| delivery | Address and credentials for | Body | Object | | Y | | |\r
-| | delivery | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | | * true |\r
-| | is expected | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| metadata_only | Set to true if subscription is | Body | Boolean | | Y | | * true |\r
-| | to receive per-file metadata | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend | Set to true if the subscription | Body | Boolean | | N | | * true |\r
-| | is in the suspended state | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id | | Body | Integer | | Y | | |\r
-| | | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.subscription |\r
-| | (feed,subscriber,publisher) | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 1 | N | | username |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| feedId | ID for the feed you are | Path | String | | Y | |\r
+| | subscribing to | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| delivery | Address and credentials for | Body | Object | | Y | |\r
+| | delivery | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | * true |\r
+| | is expected | | | | | * false |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| metadata_only | Set to true if subscription is | Body | Boolean | | Y | * true |\r
+| | to receive per-file metadata | | | | | * false |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend | Set to true if the subscription | Body | Boolean | | N | * true |\r
+| | is in the suspended state | | | | | * false |\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
+| | (feed,subscriber,publisher) | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 8 | Y | username |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
====================\r
"groupid" : 29,\r
"subscriber" : "subscriber123"\r
\r
-}\r
+ }\r
\r
Update subscription\r
-------------------\r
Sample Request\r
==============\r
\r
-curl -v -X PUT -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --location-trusted -k https://{host}:{port}/subscribe/{feedId}\r
+``curl -v -X PUT -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --location-trusted -k https://{host}:{port}/subscribe/{feedId}``\r
\r
Request Parameters:\r
===================\r
\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId | ID for the subscription you are | Path | String | | Y | | |\r
-| | updating | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| delivery | Address and credentials for | Body | Object | | Y | | |\r
-| | delivery | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | | * true |\r
-| | is expected | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| metadata_only | Set to true if subscription is | Body | Boolean | | Y | | * true |\r
-| | to receive per-file metadata | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| suspend | Set to true if the subscription | Body | Boolean | | N | | * true |\r
-| | is in the suspended state | | | | | | * false |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| group-id | | Body | Integer | | Y | | |\r
-| | | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.subscription |\r
-| | (feed,subscriber,publisher) | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 1 | N | | username |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| feedId | ID for the subscription you are | Path | String | | Y | |\r
+| | updating | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| delivery | Address and credentials for | Body | Object | | Y | |\r
+| | delivery | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | * true |\r
+| | is expected | | | | | * false |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| metadata_only | Set to true if subscription is | Body | Boolean | | Y | * true |\r
+| | to receive per-file metadata | | | | | * false |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| suspend | Set to true if the subscription | Body | Boolean | | N | * true |\r
+| | is in the suspended state | | | | | * false |\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
+| | (feed,subscriber,publisher) | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 8 | Y | username |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response/Error Codes\r
====================\r
"groupid" : 29,\r
"subscriber" : "subscriber123"\r
\r
-}\r
+ }\r
\r
\r
Get a Subscription\r
Sample Request\r
==============\r
\r
-curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{subId}\r
+``curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{subId}``\r
\r
Response/Error Codes\r
====================\r
Sample Request\r
==============\r
\r
-curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{feedId}\r
+``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{feedId}``\r
\r
Response/Error Codes\r
====================\r
Request parameters\r
==================\r
\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId | ID of the feed you are | Path | String | | Y | | |\r
-| | publishing to | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| fileId | Name of the file when it is | Path | String | | Y | | |\r
-| | published to subscribers | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| content-type | To specify type of message | Header | String | 20 | N | | application/octet-stream |\r
-| | format | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
+| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values |\r
++========================+=================================+==================+============+==============+=============+==========================================================================+\r
+| feedId | ID of the feed you are | Path | String | | Y | |\r
+| | publishing to | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
+| fileId | Name of the file when it is | Path | String | | Y | |\r
+| | published to subscribers | | | | | |\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
+| | only non nested json objects | | | | | |\r
+| | of the following type : | | | | | |\r
+| | -Numbers | | | | | |\r
+| | -Strings | | | | | |\r
+| | -Lowercase boolean | | | | | |\r
+| | -null | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+\r
\r
Response/Error Codes\r
====================\r
Sample Request\r
==============\r
\r
-curl -v -X PUT --user {user}:{password} -H "Content-Type: application/octet-stream" --data-binary @/opt/app/datartr/sampleFile.txt --post301 --location-trusted -k https://{host}:{port}/publish/{feedId}/sampleFile.txt\r
+``curl -v -X PUT --user {user}:{password} -H "Content-Type: application/octet-stream" -H X-ATT-DR-META:'{"filetype":"zip"}' --data-binary @/opt/app/datartr/sampleFile.txt --post301 --location-trusted -k https://{host}:{port}/publish/{feedId}/sampleFile.txt``\r
\r
Delete a Published file\r
-----------------------\r
Sample Request\r
==============\r
\r
-curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/publish/{feedId}/{fileId}\r
+``curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/publish/{feedId}/{fileId}``\r
\r
Response/Error Codes\r
====================\r
Request parameters\r
==================\r
\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| feedId | Id of the feed you want | Path | String | | N | | 1 |\r
-| | logs from | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| type | Select records of the | Path | String | | N | | * pub: Publish attempt |\r
-| | specified type | | | | | | * del: Delivery attempt |\r
-| | | | | | | | * exp: Delivery expiry |\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
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\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
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| end | Select records created at or | Path | String | | N | | A date-time expressed in the format |\r
-| | before specified date | | | | | | specified by RFC 3339 |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| statusCode | Select records with the | Path | String | | N | | An HTTP Integer status code or one |\r
-| | specified statusCode field | | | | | | of the following special values: |\r
-| | | | | | | | |\r
-| | | | | | | | * Success: Any code between 200-299 |\r
-| | | | | | | | * Redirect: Any code between 300-399 |\r
-| | | | | | | | * Failure: Any code > 399 |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| expiryReason | Select records with the | Path | String | | N | | |\r
-| | specified expiry reason | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| feedId | Id of the feed you want | Path | String | | N | 1 |\r
+| | logs from | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| type | Select records of the | Path | String | | N | * pub: Publish attempt |\r
+| | specified type | | | | | * del: Delivery attempt |\r
+| | | | | | | * exp: Delivery expiry |\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| end | Select records created at or | Path | String | | N | A date-time expressed in the format |\r
+| | before specified date | | | | | specified by RFC 3339 |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| statusCode | Select records with the | Path | String | | N | An HTTP Integer status code or one |\r
+| | specified statusCode field | | | | | of the following special values: |\r
+| | | | | | | |\r
+| | | | | | | * Success: Any code between 200-299 |\r
+| | | | | | | * Redirect: Any code between 300-399 |\r
+| | | | | | | * Failure: Any code > 399 |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| expiryReason | Select records with the | Path | String | | N | |\r
+| | specified expiry reason | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response Parameters\r
===================\r
Sample Request\r
==============\r
\r
-curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204\r
+``curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204``\r
\r
Subscriber logging\r
------------------\r
Request parameters\r
==================\r
\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values |\r
-+========================+=================================+==================+============+==============+=============+=====================+======================================+\r
-| subId | Id of the feed you want | Path | String | | N | | 1 |\r
-| | logs from | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| type | Select records of the | Path | String | | N | | * pub: Publish attempt |\r
-| | specified type | | | | | | * del: Delivery attempt |\r
-| | | | | | | | * exp: Delivery expiry |\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
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\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
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| end | Select records created at or | Path | String | | N | | A date-time expressed in the format |\r
-| | before specified date | | | | | | specified by RFC 3339 |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| statusCode | Select records with the | Path | String | | N | | An Http Integer status code or one |\r
-| | specified statusCode field | | | | | | of the following special values: |\r
-| | | | | | | | |\r
-| | | | | | | | * Success: Any code between 200-299 |\r
-| | | | | | | | * Sedirect: Any code between 300-399 |\r
-| | | | | | | | * Sailure: Any code > 399 |\r
-| | | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
-| expiryReason | Select records with the | Path | String | | N | | |\r
-| | specified expiry reason | | | | | | |\r
-+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values |\r
++========================+=================================+==================+============+==============+=============+======================================+\r
+| subId | Id of the feed you want | Path | String | | N | 1 |\r
+| | logs from | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| type | Select records of the | Path | String | | N | * pub: Publish attempt |\r
+| | specified type | | | | | * del: Delivery attempt |\r
+| | | | | | | * exp: Delivery expiry |\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\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
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| end | Select records created at or | Path | String | | N | A date-time expressed in the format |\r
+| | before specified date | | | | | specified by RFC 3339 |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| statusCode | Select records with the | Path | String | | N | An Http Integer status code or one |\r
+| | specified statusCode field | | | | | of the following special values: |\r
+| | | | | | | |\r
+| | | | | | | * Success: Any code between 200-299 |\r
+| | | | | | | * Redirect: Any code between 300-399 |\r
+| | | | | | | * Failure: Any code > 399 |\r
+| | | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
+| expiryReason | Select records with the | Path | String | | N | |\r
+| | specified expiry reason | | | | | |\r
++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+\r
\r
Response Parameters\r
===================\r
Sample Request\r
==============\r
\r
-curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204
\ No newline at end of file
+``curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204``\r