Subscription



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/subscriptions

Summary


Resources Methods
https://localhost:8443/api/rest/subscriptions

GET  Retrieves a list of current subscriptions the user is authorized to view.

https://localhost:8443/api/rest/subscriptions/{subscription-identifier}

GET  Retrieves a subscription.

PUT  Updates a subscription.

DELETE  Terminates a subscription.

https://localhost:8443/api/rest/subscriptions/{subscription-identifier}/send-update-notification-now

POST  Causes an update notification to be published, even though the resource has not changed.

Resources


https://localhost:8443/api/rest/subscriptions


Methods

GET


Retrieves a list of current subscriptions the user is authorized to view.
Users with Provisioner or Administrator roles can retrieve all subscriptions on the DMA.
Users without these roles can only retrieve subscriptions that they created.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-subscription-list+xml
application/vnd.plcm.plcm-subscription-list+json
application/vnd.plcm.plcm-subscription-list-v2+xml
application/vnd.plcm.plcm-subscription-list-v2+json
Information successfully retrieved
304
Subscription information has not changed since the last search.

Note: The API client must provide the "plcm-subscription-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-subscription-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the subscription on the server.

https://localhost:8443/api/rest/subscriptions/{subscription-identifier}


Template Parameters

Name Type Description
subscription-identifier xs:string The subscription identifier

Methods

GET


Retrieves a subscription.
The user must be the subscription creator or have Administrator or Provisioner roles.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-subscription+xml
application/vnd.plcm.plcm-subscription+json
application/vnd.plcm.plcm-subscription-v2+xml
application/vnd.plcm.plcm-subscription-v2+json
Information successfully retrieved
304
Subscription information has not changed since the last search.

Note: The API client must provide the "plcm-subscription" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-subscription" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
the subscription on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. The user must be the subscription creator or have Administrator or Provisioner roles.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such subscription

PUT


Updates a subscription. This can be used to update the time-to-live value of the subscription or to reset
the timer of the subscription. time-to-live is the only valid field to be updated.
The user must be the subscription creator or have Administrator or Provisioner roles.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-subscription+xml
application/vnd.plcm.plcm-subscription+json
application/vnd.plcm.plcm-subscription-v2+xml
application/vnd.plcm.plcm-subscription-v2+json

Response

Status Representation Description
204 Subscription successfully updated
400 text/plain
Bad request
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. The user must be the subscription creator or have Administrator or Provisioner roles.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such subscription
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-participant.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.

DELETE


Terminates a subscription.
The user must be the subscription creator or have Administrator or Provisioner roles.
[tags: DMA]

Response

Status Representation Description
204 Subscription successfully terminated
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. The user must be the subscription creator or have Administrator or Provisioner roles.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such subscription

https://localhost:8443/api/rest/subscriptions/{subscription-identifier}/send-update-notification-now


Template Parameters

Name Type Description
subscription-identifier xs:string The subscription identifier

Methods

POST


Causes an update notification to be published, even though the resource has not changed.
The user must be the subscription creator or have Administrator or Provisioner roles.
Note: This will reset the sequence number of the notifications to 1 starting with the next
notification.
[tags: DMA]

Response

Status Representation Description
204 Update requested successfully
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. The user must be the subscription creator or have Administrator or Provisioner roles.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such subscription
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

time-to-live is out of range. Correct values are "0" (magic number which sets end time to the max, 26 hours), or
any integer between 1 and 93600 (26 hours) in seconds.