DMaaP Data Router API
The API Provisioning Model
The DMaaP Data Router (DR) provisioning API defines two resource types - the feed and the subscription, each with JSON representations. The API models the provisioning data as a collection of feeds that are known to the DR (the feeds collection), with each feed containing a collection of the subscriptions to the feed. The standard HTTP operations (POST, GET, PUT, and DELETE), used in conjunction with these resource representations, allow an API user to create, get information about, modify, and delete feeds and subscriptions.
HTTP Service APIs
DMaaP Data Router utilizes an HTTPS REST API to service all transactions. HTTPS and REST standards are followed so clients as varied as CURL, Java applications and even Web Browsers will work to interact with the Data Router.
General HTTP Requirements
A DMaaP Data Router transactions consists of 4 distinct segments, HTTP URL, HTTP Header, HTTP Body (POST/PUT) and HTTP Response. The general considerations for each segment are as follows and are required for each of the specific transactions described in this section.
HTTP URL
http[s]://{serverBaseURL}/{resourcePath}
The serverBaseURL points to DMaaP Data Router host:port that will service the request.
The resourcePath specifies the service that the client is attempting to reach.
HTTP Header
Specifies HTTP Headers, such as Content-Type, that define the parameters of the HTTP Transaction
HTTP Body
The HTTP Body contains the feed content when creating a feed.
Create a Feed
Description: Creates a unique feed URL to service the publisher/subscriber model.
POST /
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Set By |
Updatable? |
Required |
Valid/Example Values |
---|---|---|---|---|---|---|---|---|
name |
Feed name |
Body |
String |
<=20 |
Client |
N |
Y |
|
version |
Feed version |
Body |
String |
<=20 |
Client |
N |
Y |
v1.0.0 |
description |
Feed description |
Body |
String |
<=256 |
Client |
Y |
N |
|
business description |
Business description |
Body |
String |
<=256 |
Client |
Y |
N |
|
authorization |
Information for authorizing publishing requests |
Body |
Client |
Y |
Y |
|||
suspend |
Set to true if the feed is in the suspended state |
Body |
Boolean |
Client |
Y |
N |
|
|
group-id |
Auth group for feed management |
Body |
Integer |
Client |
Y |
N |
0 (default) |
|
Content-Type |
To specify type of message |
Header |
String |
Client |
N |
Y |
application/vnd.dmaap-dr.feed |
|
Authorization |
The user / AppId to be authorized |
Header |
String |
Client |
N |
Y |
Basic <credentials> |
|
X-DMAAP-DR-ON-BEHALF-OF |
Publisher identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
DR |
N |
Y |
username |
Response Codes
- Success:
200
- Error:
See Response Codes
- Consumes
application/json
- Produces
application/json
Sample Request
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}
Sample Body
{
"name": "ONAP Data Feed",
"version": "v1.0",
"authorization": {
"classification": "unclassified",
"endpoint_addrs": [
],
"endpoint_ids": [
{
"id": "dradmin",
"password": "dradmin"
}
]
}
}
Sample Response
{
"suspend": false,
"groupid": 0,
"description": "",
"version": "v1.0",
"authorization": {
"endpoint_addrs": [
],
"classification": "unclassified",
"endpoint_ids": [
{
"password": "dradmin",
"id": "dradmin"
}
]
},
"name": "ONAP Data Feed",
"business_description": "",
"publisher": "{user}",
"links": {
"subscribe": "https://dmaap-dr-prov/subscribe/1",
"log": "https://dmaap-dr-prov/feedlog/1",
"publish": "https://dmaap-dr-prov/publish/1",
"self": "https://dmaap-dr-prov/feed/1"
}
}
Update a Feed
Description: Update a feed with new parameters.
PUT /feed/{feedId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Required |
---|---|---|---|---|---|
name |
Feed name |
Body |
String |
<=20 |
Y |
description |
Feed description |
Body |
String |
<=256 |
N |
business description |
Business description |
Body |
String |
<=256 |
N |
authorization |
Information for authorizing publishing requests |
Body |
Y |
||
suspend |
Set to true if the feed is in the suspended state |
Body |
Boolean |
N |
|
group-id |
Auth group for feed management |
Body |
Integer |
N |
|
Content-type |
To specify type of message (feed,subscriber,publisher) |
Header |
String |
Y |
|
Authorization |
The user / AppId to be authorized |
Header |
String |
Y |
|
X-DMAAP-DR-ON-BEHALF-OF |
Publisher identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
Y |
Response Codes
- Success:
200
- Error:
See Response Codes
- Consumes
application/json
- Produces
application/json
Sample Request
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}
Sample Body
{
"name": "ONAP Data Feed",
"business_description": "Updated ONAP Feed",
"groupid": 33,
"description": "Updated ONAP Feed",
"authorization": {
"endpoint_addrs": [
"10.1.2.3"
],
"classification": "unclassified",
"endpoint_ids": [
{
"password": "dradmin",
"id": "dradmin"
},
{
"password": "demo123456!",
"id": "onap"
}
]
}
}
Sample Response
{
"suspend": false,
"groupid": 33,
"description": "Updated ONAP Feed",
"authorization": {
"endpoint_addrs": [
"10.1.2.3"
],
"classification": "unclassified",
"endpoint_ids": [
{
"password": "dradmin",
"id": "dradmin"
},
{
"password": "demo123456!",
"id": "onap"
}
]
},
"name": "ONAP Data Feed1",
"business_description": "Updated ONAP Feed",
"publisher": "{user}",
"links": {
"subscribe": "https://dmaap-dr-prov/subscribe/1",
"log": "https://dmaap-dr-prov/feedlog/1",
"publish": "https://dmaap-dr-prov/publish/1",
"self": "https://dmaap-dr-prov/feed/1"
}
}
Get a Feed
Description: Retrieves a representation of the specified feed.
GET /feed/{feedId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Required |
---|---|---|---|---|---|
Authorization |
The user / AppId to be authorized |
Header |
String |
Y |
|
X-DMAAP-DR-ON-BEHALF-OF |
Publisher identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
Y |
Response Codes
- Success:
200
- Error:
See Response Codes
- Produces
application/json
Sample Request
curl -k -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}
Sample Response
{
"suspend": false,
"groupid": 33,
"description": "Updated ONAP Feed",
"version": "v1.0",
"authorization": {
"endpoint_addrs": [
"10.1.2.3",
"173.2.33.4"
],
"classification": "unclassified",
"endpoint_ids": [
{
"password": "dradmin",
"id": "dradmin"
}
]
},
"name": "ONAP Data Feed",
"business_description": "Updated ONAP Feed",
"publisher": "{user}",
"links": {
"subscribe": "https://dmaap-dr-prov/subscribe/1",
"log": "https://dmaap-dr-prov/feedlog/1",
"publish": "https://dmaap-dr-prov/publish/1",
"self": "https://dmaap-dr-prov/feed/1"
}
}
Delete a Feed
Description: Deletes a specified feed
DELETE /feed/{feedId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Required |
---|---|---|---|---|---|
Authorization |
The user / AppId to be authorized |
Header |
String |
Y |
|
X-DMAAP-DR-ON-BEHALF-OF |
Publisher identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
Y |
Response Codes
- Success:
204
- Error:
See Response Codes
Sample Request
curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}
Subscribe to Feed
Description: Subscribes to a created feed to receive files published to that feed.
POST /subscribe/{feedId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Set By |
Updatable? |
Required |
Valid/Example Values |
---|---|---|---|---|---|---|---|---|
feedId |
ID for the feed you are subscribing to |
Path |
String |
Client |
N |
Y |
1 |
|
delivery |
Address and credentials for delivery |
Body |
Client |
Y |
Y |
|||
follow_redirect |
Set to true if feed redirection is expected |
Body |
Boolean |
Client |
Y |
N |
|
|
metadata_only |
Set to true if subscription is to receive per-file metadata |
Body |
Boolean |
Client |
Y |
Y |
|
|
suspend |
Set to true if the subscription is in the suspended state |
Body |
Boolean |
Client |
Y |
N |
|
|
decompress |
Set to true if the data is to be decompressed for subscriber |
Body |
Boolean |
Client |
Y |
N |
|
|
group-id |
Auth group for sub management |
Body |
Integer |
Client |
Y |
Y |
22 |
|
Content-type |
To specify type of message (feed,subscriber,publisher) |
Header |
String |
Client |
N |
Y |
application/vnd.dmaap-dr.subscription |
|
Authorization |
The user / AppId to be authorized |
Header |
String |
Client |
N |
Y |
Basic <credentials> |
|
X-DMAAP-DR-ON-BEHALF-OF |
Publisher identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
DR |
N |
Y |
username |
Response Codes
- Success:
201
- Error:
See Response Codes
- Consumes
application/json
- Produces
application/json
Sample Request
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}
Sample Body
{
"delivery": {
"url": "http://dmaap-dr-subscriber:7070/",
"user": "LOGIN",
"password": "PASSWORD",
"use100": true
},
"metadataOnly": false,
"groupid": 22,
"follow_redirect": true,
"suspend": false,
"decompress": true
}
Sample Response
{
"suspend": false,
"delivery": {
"use100": true,
"password": "PASSWORD",
"user": "LOGIN",
"url": "http://dmaap-dr-subscriber:7070/"
},
"subscriber": "{user}",
"groupid": 1,
"metadataOnly": false,
"follow_redirect": true,
"decompress": true,
"links": {
"feed": "https://dmaap-dr-prov/feed/1",
"log": "https://dmaap-dr-prov/sublog/1",
"self": "https://dmaap-dr-prov/subs/1"
},
"created_date": 1553707279509
}
Update subscription
Description: Update a subscription to a feed.
PUT /subs/{subId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Required |
---|---|---|---|---|---|
subId |
ID for the subscription you are updating |
Path |
String |
Y |
|
delivery |
Address and credentials for delivery |
Body |
Y |
||
follow_redirect |
Set to true if feed redirection is expected |
Body |
Boolean |
N |
|
metadata_only |
Set to true if subscription is to receive per-file metadata |
Body |
Boolean |
Y |
|
suspend |
Set to true if the subscription is in the suspended state |
Body |
Boolean |
N |
|
decompress |
Set to true if the data is to be decompressed for subscriber |
Body |
Boolean |
N |
|
group-id |
Auth group for sub management |
Body |
Integer |
Y |
|
Content-type |
To specify type of message (feed,subscriber,publisher) |
Header |
String |
Y |
|
Authorization |
The user / AppId to be authorized |
Header |
String |
Y |
|
X-DMAAP-DR-ON-BEHALF-OF |
Publisher identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
Y |
Response Codes
- Success:
200
- Error:
See Response Codes
- Consumes
application/json
- Produces
application/json
Sample Request
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}
Sample Body
{
"delivery": {
"url": "http://dmaap-dr-subscriber:7070/",
"user": "NEW_LOGIN",
"password": "NEW_PASSWORD",
"use100": false
},
"metadataOnly": true,
"groupid": 67,
"follow_redirect": false,
"decompress": false
}
Sample Response
{
"suspend": false,
"delivery": {
"use100": false,
"password": "NEW_PASSWORD",
"user": "NEW_LOGIN",
"url": "http://dmaap-dr-subscriber:7070/"
},
"subscriber": "{user}",
"groupid": 67,
"metadataOnly": true,
"follow_redirect": false,
"decompress": false,
"links": {
"feed": "https://dmaap-dr-prov/feed/1",
"log": "https://dmaap-dr-prov/sublog/1",
"self": "https://dmaap-dr-prov/subs/1"
},
"created_date": 1553714446614
}
Get a Subscription
Description: Retrieves a representation of the specified subscription.
GET /subs/{subId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Required |
---|---|---|---|---|---|
Authorization |
The user / AppId to be authorized |
Header |
String |
Y |
|
X-DMAAP-DR-ON-BEHALF-OF |
Subscriber identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
Y |
Response Codes
- Success:
200
- Error:
See Response Codes
- Produces
application/json
Sample Request
curl -k -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}
Sample Response
{
"suspend": false,
"delivery": {
"use100": false,
"password": "NEW_PASSWORD",
"user": "NEW_LOGIN",
"url": "http://dmaap-dr-subscriber:7070/"
},
"subscriber": "{user}",
"groupid": 67,
"metadataOnly": true,
"privilegedSubscriber": false,
"follow_redirect": false,
"decompress": false,
"links": {
"feed": "https://dmaap-dr-prov/feed/2",
"log": "https://dmaap-dr-prov/sublog/6",
"self": "https://dmaap-dr-prov/subs/6"
}
}
Delete a subscription
Description: Deletes a specified subscription
DELETE /subs/{subId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
MaxLen |
Required |
---|---|---|---|---|---|
Authorization |
The user / AppId to be authorized |
Header |
String |
Y |
|
X-DMAAP-DR-ON-BEHALF-OF |
Subscriber identity as passed in X-DMAAP-DR-ON-BEHALF-OF at creation time |
Header |
String |
<=8 |
Y |
Response Codes
- Success:
204
- Error:
See Response Codes
Sample Request
curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}
Publish to Feed
Description: Publish data to a given feed
PUT /publish/{feedId}/{fileId}
Request parameters
Name |
Description |
Param Type |
Data Type |
MaxLen |
Required |
Valid/Example Values |
---|---|---|---|---|---|---|
feedId |
ID of the feed you are publishing to |
Path |
String |
Y |
||
fileId |
Name of the file when it is published to subscribers |
Path |
String |
Y |
||
Content-type |
To specify type of message format |
Header |
String |
Y |
application/octet-stream |
|
X-DMAAP-DR-META |
Metadata for the file. Accepts only non nested json objects of the following type:
|
Header |
String |
<=4096 |
N |
|
Authorization |
An EID Object with publish permissions. |
Header |
String |
Y |
|
Response Codes
- Success:
204
- Error:
See Response Codes
Sample Request
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}/{fileId}
Delete/Retract a Published file
Description: Deletes/retracts a specified published file
DELETE /publish/{feedId}/{fileId}
Request Parameters:
Field |
Description |
Param Type |
Data Type |
Required |
Valid/Example Values |
---|---|---|---|---|---|
Authorization |
An EID Object with publish permissions. |
Header |
String |
Y |
|
feedId |
ID of the feed that was publishing to |
Path |
String |
Y |
|
fileId |
Name of the file when it was published to subscribers |
Path |
String |
Y |
Response Codes
- Success:
204
- Error:
See Response Codes
Sample Request
curl -k -X DELETE --user {user}:{password} --location-trusted https://{host}:{port}/publish/{feedId}/{fileId}
Feed logging
Description: View logging information for specified feeds, which can be narrowed down with further parameters
GET /feedlog/{feedId}?{queryParam}
Request parameters
Name |
Description |
Param Type |
Data Type |
Required |
Valid/Example Values |
---|---|---|---|---|---|
feedId |
Id of the feed you want logs for |
Path |
String |
Y |
1 |
type |
Select records of the specified type |
Path |
String |
N |
|
publishId |
Select records with specified publish id, carried in the X-DMAAP-DR-PUBLISH-ID header from original publish request |
Path |
String |
N |
|
start |
Select records created at or after specified date |
Path |
String |
N |
A date-time expressed in the format specified by RFC 3339 |
end |
Select records created at or before specified date |
Path |
String |
N |
A date-time expressed in the format specified by RFC 3339 |
statusCode |
Select records with the specified statusCode field |
Path |
String |
N |
An HTTP Integer status code or one of the following special values:
|
expiryReason |
Select records with the specified expiry reason |
Path |
String |
N |
|
filename |
Select published records with the specified filename |
Path |
String |
N |
Response Parameters
Name |
Description |
---|---|
type |
Record type:
|
date |
The UTC date and time at which the record was generated, with millisecond resolution in the format specified by RFC 3339 |
publishId |
The unique identifier assigned by the DR at the time of the initial publication request (carried in the X-DMAAP-DR-PUBLISH-ID header in the response to the original publish request) |
requestURI |
The Request-URI associated with the request |
method |
The HTTP method (PUT or DELETE) for the request |
contentType |
The media type of the payload of the request |
contentLength |
The size (in bytes) of the payload of the request |
sourceIp |
The IP address from which the request originated |
endpointId |
The identity used to submit a publish request to the DR |
deliveryId |
The identity used to submit a delivery request to a subscriber endpoint |
statusCode |
The HTTP status code in the response to the request. A value of -1 indicates that the DR was not able to obtain an HTTP status code |
expiryReason |
The reason that delivery attempts were discontinued:
|
attempts |
Total number of attempts made before delivery attempts were discontinued |
filename |
File name associated with a publish record |
Response Codes
- Success:
200
- Error:
See Response Codes
- Produces
application/json
Sample Request
curl -k https://{host}:{port}/feedlog/{feedId}?statusCode=204``
Sample Response
[
{
"statusCode": 204,
"publishId": "1553715307322.dmaap-dr-node",
"requestURI": "https://dmaap-dr-node/publish/1/hello",
"sourceIP": "172.19.0.1",
"method": "PUT",
"contentType": "application/octet-stream",
"endpointId": "dradmin",
"type": "pub",
"date": "2019-03-27T19:35:07.324Z",
"contentLength": 14,
"fileName": "hello"
},
{
"statusCode": 204,
"publishId": "1553715312071.dmaap-dr-node",
"requestURI": "https://dmaap-dr-node/publish/2/hello",
"sourceIP": "172.19.0.1",
"method": "PUT",
"contentType": "application/octet-stream",
"endpointId": "onap",
"type": "pub",
"date": "2019-03-27T19:35:12.072Z",
"contentLength": 14,
"fileName": "hello2"
}
]
Subscription logging
Description: View logging information for specified subscriptions, which can be narrowed down with further parameters
GET /sublog/{subId}?{queryParam}
Request parameters
Name |
Description |
Param Type |
Data Type |
Required |
Valid/Example Values |
---|---|---|---|---|---|
subId |
Id of the subscription you want logs for |
Path |
String |
Y |
1 |
type |
Select records of the specified type |
Path |
String |
N |
|
publishId |
Select records with specified publish id, carried in the X-DMAAP-DR-PUBLISH-ID header from original publish request |
Path |
String |
N |
|
start |
Select records created at or after specified date |
Path |
String |
N |
A date-time expressed in the format specified by RFC 3339 |
end |
Select records created at or before specified date |
Path |
String |
N |
A date-time expressed in the format specified by RFC 3339 |
statusCode |
Select records with the specified statusCode field |
Path |
String |
N |
An Http Integer status code or one of the following special values:
|
expiryReason |
Select records with the specified expiry reason |
Path |
String |
N |
Response Parameters
Name |
Description |
---|---|
type |
Record type:
|
date |
The UTC date and time at which the record was generated, with millisecond resolution in the format specified by RFC 3339 |
publishId |
The unique identifier assigned by the DR at the time of the initial publication request(carried in the X-DMAAP-DR-PUBLISH-ID header in the response to the original publish request) to a feed log URL or subscription log URL known to the system |
requestURI |
The Request-URI associated with the request |
method |
The HTTP method (PUT or DELETE) for the request |
contentType |
The media type of the payload of the request |
contentLength |
The size (in bytes) of the payload of the request |
sourceIp |
The IP address from which the request originated |
endpointId |
The identity used to submit a publish request to the DR |
deliveryId |
The identity used to submit a delivery request to a subscriber endpoint |
statusCode |
The HTTP status code in the response to the request. A value of -1 indicates that the DR was not able to obtain an HTTP status code |
expiryReason |
The reason that delivery attempts were discontinued:
|
attempts |
Total number of attempts made before delivery attempts were discontinued |
Response Codes
- Success:
200
- Error:
See Response Codes
- Produces
application/json
Sample Request
curl -k https://{host}:{port}/sublog/{subId}?statusCode=204
Sample Response
[
{
"statusCode": 204,
"publishId": "1553715307322.dmaap-dr-node",
"requestURI": "https://dmaap-dr-node/publish/1/hello",
"sourceIP": "172.19.0.1",
"method": "PUT",
"contentType": "application/octet-stream",
"endpointId": "dradmin",
"type": "pub",
"date": "2019-03-27T19:35:07.324Z",
"contentLength": 14,
"fileName": "hello"
},
{
"statusCode": 204,
"publishId": "1553715312071.dmaap-dr-node",
"requestURI": "https://dmaap-dr-node/publish/2/hello",
"sourceIP": "172.19.0.1",
"method": "PUT",
"contentType": "application/octet-stream",
"endpointId": "onap",
"type": "pub",
"date": "2019-03-27T19:35:12.072Z",
"contentLength": 14,
"fileName": "hello2"
}
]
Feed Authorization Object
Field |
Type |
Description |
Restrictions |
---|---|---|---|
classification |
string |
An indicator of the feed’s data security classification |
Length <=32 |
endpoint_ids |
EID Object [] |
Array of objects defining the identities that are allowed to publish to this feed |
At least 1 id in the array |
endpoint_addrs |
string[] |
Array of IP addresses or IP subnetwork addresses that are allowed to publish to this feed; an empty array indicates that publish requests are permitted from any IP address |
Each string must be a valid textual representation of IPv4 or IPv6 host address or subnetwork address. |
Endpoint Identity Object
Field |
Type |
Description |
Restrictions |
---|---|---|---|
id |
string |
Publishing endpoint identifier |
Length <= 20 |
password |
string |
Password associated with id |
Length <= 32 |
Feed Links Object
Field |
Description |
Symbolic Name |
---|---|---|
self |
URL pointing to this feed, used for updating and deleting the feed. |
<feedURL> |
publish |
URL for publishing requests for this feed |
<publishURL> |
subscribe |
URL for subscribing to this feed |
<subscribeURL> |
log |
URL for accessing log information about this feed |
<feedLogURL> |
Delivery Object
Field |
Type |
Description |
Restrictions |
---|---|---|---|
url |
string |
URL to which deliveries for this subscription should be directed Valid HTTPS URL |
length <= 256 |
user |
string |
User ID to be passed in the Authorization header when deliveries are made |
Length <= 20 |
password |
string |
Password to be passed in the Authorization header when deliveries are made |
Length <= 32 |
use100 |
boolean |
Flag indicating whether the DR should use the HTTP 100-continue feature |
Must be: true to use 100-continue false to disable using 100-continue |
Sub Links Object
Field |
Description |
Symbolic Name |
---|---|---|
self |
URL pointing to this subscription, used for updating and deleting the subscription. |
<subscriptionURL> |
feed |
URL of the feed to which this subscription applies; the same URL as the <feedURL> in the representation of the feed |
<feedURL> |
log |
URL for accessing log information about this subscription |
<subLogURL> |
Response/Error Codes
Response statusCode |
Response Description |
---|---|
200 to 299 |
Success Response |
400 |
Bad request - The request is defective in some way. Possible causes:
|
401 |
Indicates that the request was missing the Authorization header or, if the header was presented, the credentials were not acceptable |
403 |
Forbidden - The request failed authorization. Possible causes:
|
404 |
Not Found - The Request-URI does not point to a resource that is known to the API. |
405 |
Method Not Allowed - The HTTP method in the request is not supported for the resource addressed by the Request-URI. |
406 |
Not Acceptable - The request has an Accept header indicating that the requester will not accept a response with application/vnd.dmaap-dr.log-list content. |
415 |
Unsupported Media Type - The media type in the requests Content-Type header is not appropriate for the request. |
500 |
Internal Server Error - The DR API server encountered an internal error and could not complete the request. |
503 |
Service Unavailable - The DR API service is currently unavailable |
-1 |
Failed Delivery |