+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
+Response/Error Codes\r
+====================\r
+\r
++------------------------+-------------------------------------------+\r
+| Response statusCode | Response Description |\r
++========================+===========================================+\r
+| 200 | Successful query |\r
++------------------------+-------------------------------------------+\r
+| 400 | Bad request - The request is defective in |\r
+| | some way. Possible causes: |\r
+| | |\r
+| | * JSON object in request body does not |\r
+| | conform to the spec. |\r
+| | * Invalid parameter value in query string |\r
++------------------------+-------------------------------------------+\r
+| 401 | Indicates that the request was missing the|\r
+| | Authorization header or, if the header |\r
+| | was presented, the credentials were not |\r
+| | acceptable |\r
++------------------------+-------------------------------------------+\r
+| 403 | The request failed authorization. |\r
+| | Possible causes: |\r
+| | |\r
+| | * Request originated from an unauthorized |\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
+| | authorized to perform |\r
++------------------------+-------------------------------------------+\r
+| 404 | Not Found - The Request-URI does not point|\r
+| | to a resource that is known to the API. |\r
++------------------------+-------------------------------------------+\r
+| 405 | Method Not Allowed - The HTTP method in |\r
+| | the request is not supported for the |\r
+| | resource addressed by the Request-URI. |\r
++------------------------+-------------------------------------------+\r
+| 415 | Unsupported Media Type - The media type in|\r
+| | the request’s Content-Type header is not |\r
+| | appropriate for the request. |\r
++------------------------+-------------------------------------------+\r
+| 500 | Internal Server Error - The DR API server |\r
+| | encountered an internal error and could |\r
+| | not complete the request. |\r
++------------------------+-------------------------------------------+\r
+| 503 | Service Unavailable - The DR API service |\r
+| | is currently unavailable |\r
++------------------------+-------------------------------------------+\r
+| -1 | Failed Delivery |\r
++------------------------+-------------------------------------------+\r
+\r
+Sample Body\r
+===========\r
+.. code-block:: json\r
+\r
+ {\r
+ "delivery" :{\r
+ "url" : "http://172.18.0.3:7070/",\r
+ "user" : "LOGIN",\r
+ "password" : "PASSWORD",\r
+ "use100" : true\r
+ },\r
+ "metadataOnly" : false,\r
+ "suspend" : false,\r
+ "groupid" : 29,\r
+ "subscriber" : "sg481n"\r
+\r
+}\r
+\r
+\r
+Get a Subscription\r
+------------------\r
+\r
+**Description**: Retrieves a representation of the specified subscription.\r
+\r
+Request URL\r
+===========\r
+\r
+http[s]://{host}:{port}/subscribe/{subId}\r
+\r
+* {subId}: Id of the subscription you wish to see a representation of\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}/subscribe/{subId}\r
+\r
+Response/Error Codes\r
+====================\r
+\r
++------------------------+-------------------------------------------+\r
+| Response statusCode | Response Description |\r
++========================+===========================================+\r
+| 200 | Successful query |\r
++------------------------+-------------------------------------------+\r
+| 401 | Indicates that the request was missing the|\r
+| | Authorization header or, if the header |\r
+| | was presented, the credentials were not |\r
+| | acceptable |\r
++------------------------+-------------------------------------------+\r
+| 403 | The request failed authorization. |\r
+| | Possible causes: |\r
+| | |\r
+| | * Request originated from an unauthorized |\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
+| | authorized to perform |\r
++------------------------+-------------------------------------------+\r
+| 404 | Not Found - The Request-URI does not point|\r
+| | to a resource that is known to the API. |\r
++------------------------+-------------------------------------------+\r
+| 405 | Method Not Allowed - The HTTP method in |\r
+| | the request is not supported for the |\r
+| | resource addressed by the Request-URI. |\r
++------------------------+-------------------------------------------+\r
+| 415 | Unsupported Media Type - The media type in|\r
+| | the request’s Content-Type header is not |\r
+| | appropriate for the request. |\r
++------------------------+-------------------------------------------+\r
+| 500 | Internal Server Error - The DR API server |\r
+| | encountered an internal error and could |\r
+| | not complete the request. |\r
++------------------------+-------------------------------------------+\r
+| 503 | Service Unavailable - The DR API service |\r
+| | is currently unavailable |\r
++------------------------+-------------------------------------------+\r
+| -1 | Failed Delivery |\r
++------------------------+-------------------------------------------+\r
+\r
+Publish to Feed\r
+---------------\r
+\r
+**Description**: Publish a file to a created feed so that it can be shared to any subscribers of that feed\r
+\r
+Request URL\r
+===========\r
+\r
+http[s]://{host}:{port}/publish/{feedId}/{fileName}\r
+\r
+* {feedId} is the id of the feed you are publishing to.\r
+* {fileId} is the id of the file you are publishing onto the feed.\r
+\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
+Response/Error Codes\r
+====================\r
+\r
++------------------------+---------------------------------+\r
+| Response statusCode | Response Description |\r
++========================+=================================+\r
+| 204 | Successful PUT or DELETE |\r
++------------------------+---------------------------------+\r
+| 400 | Failure - Malformed request |\r
++------------------------+---------------------------------+\r
+| 401 | Failure - Request was missing |\r
+| | authorization header, or |\r
+| | credentials were not accepted |\r
++------------------------+---------------------------------+\r
+| 403 | Failure - User could not be |\r
+| | authenticated, or was not |\r
+| | authorized to make the request |\r
++------------------------+---------------------------------+\r
+| 404 | Failure - Path in the request |\r
+| | URL did not point to a valid |\r
+| | feed publishing URL |\r
++------------------------+---------------------------------+\r
+| 500 | Failure - DR experienced an |\r
+| | internal problem |\r
++------------------------+---------------------------------+\r
+| 503 | Failure - DR is not currently |\r
+| | available |\r
++------------------------+---------------------------------+\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
+\r
+Feed logging\r
+------------\r
+\r
+**Description**: View logging information for specified feeds, which can be narrowed down with further parameters\r
+\r
+Request URL\r
+===========\r
+\r
+\r
+http[s]://{host}:{port}/feedlog/{feedId}?{queryParameter}\r
+\r
+* {feedId} is the id of the feed you wish to get logs from\r
+* {queryParameter} a parameter passed through to narrow the returned logs. multiple parameters can be passed\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
+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
+Response/Error Codes\r
+====================\r
+\r
++------------------------+-------------------------------------------+\r
+| Response statusCode | Response Description |\r
++========================+===========================================+\r
+| 200 | Successful query |\r
++------------------------+-------------------------------------------+\r
+| 400 | Bad request - The request is defective in |\r
+| | some way. Possible causes: |\r
+| | |\r
+| | * Unrecognized parameter name in query |\r
+| | string |\r
+| | * Invalid parameter value in query string |\r
++------------------------+-------------------------------------------+\r
+| 404 | Not Found - The request was not directed |\r
+| | to a feed log URL or subscription log URL |\r
+| | known to the system |\r
++------------------------+-------------------------------------------+\r
+| 405 | Method not allowed - The HTTP method in |\r
+| | the request was something other than GET |\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
++------------------------+-------------------------------------------+\r
+| 500 | Internal Server Error - The DR API server |\r
+| | encountered an internal error and could |\r
+| | not complete the request |\r
++------------------------+-------------------------------------------+\r
+| 503 | Service Unavailable - The DR API service |\r
+| | is currently unavailable |\r
++------------------------+-------------------------------------------+\r
+\r
+Sample Request\r
+==============\r
+\r
+curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204\r
+\r
+Subscriber logging\r
+------------------\r
+\r
+**Description**: View logging information for specified subscriptions, which can be narrowed down with further parameters\r
+\r
+Request URL\r
+===========\r
+\r
+\r
+http[s]://{host}:{port}/sublog/{subId}?{queryParameter}\r
+\r
+* {subId} is the id of the feed you wish to get logs from\r
+* {queryParameter} a parameter passed through to narrow the returned logs. multiple parameters can be passed\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
+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) 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