Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Job Completed Notification Registration

Description

Get information about a job completed notification registration.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/job_completed_notification_registration/{UUID for the notification}/

To determine the UUID for a notification, see Get Job Completed Notification Registrations.

Responses

Response Elements

<Data>
   <CreationDate>{YYYY-MM-DDThh:mm:ss.xxxZ}</CreationDate>
   <Format>DEFAULT|JSON|XML</Format>
   <Id>{string}</Id>
   <JobId>{string}</JobId>
   <LastFailure>{string}</LastFailure>
   <LastHttpResponseCode>{32‑bit integer}</LastHttpResponseCode>
   <LastNotification>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastNotification>
   <NamingConvention>
      CONCAT_LOWERCASE|CONSTANT|UNDERSCORED|
      CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE|
      CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE
   </NamingConvention>
   <NotificationEndPoint>{string}</NotificationEndPoint>
   <NotificationHttpMethod>POST|PUT</NotificationHttpMethod>
   <NumberOfFailuresSinceLastSuccess>
      {32‑bit integer}
   </NumberOfFailuresSinceLastSuccess>
   <UserId>{string}</UserId>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
CreationDate	The date the notification registration was created in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Format	The format of the notification. Values: DEFAULT (XML), JSON, XML
ID	The UUID for the notification.
JobId	The UUID for the job that completed.
LastFailure	The exception message for the last failure to send a notification to this notification registration.
LastHttpResponseCode	The last response code returned by the notification end point.
LastNotification	Date and time of the last notification attempt by the BlackPearl Converged Storage System.
NamingConvention	The scheme used for naming within the notification sent. Values: CONCAT_LOWERCASE, CONSTANT, UNDERSCORED, CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE, CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE
NotificationEnd Point	The HTTP or HTTPS URL of a web server capable of receiving notification messages from the BlackPearl Converged Storage System.
NotificationHttp Method	The HTTP request method type. Values: POST, PUT
NumberOfFailuresSinceLastSuccess	Number of failed notification attempts since last successful notification.
UserId	The UUID for the user who created the notification registration.

Example

Sample Request

This request gets information about the job completed notification registration with the UUID e2ae9bc2-d70e-46d4-9af7-82d971827cb8.

GET http://blackpearl-hostname/_rest_/job_completed_notification_registration/e2ae9bc2-d70e-46d4-9af7-82d971827cb8 HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <CreationDate>2014-10-16T18:33:58.339Z</CreationDate>
   <Format>DEFAULT</Format>
   <Id>e2ae9bc2-d70e-46d4-9af7-82d971827cb8</Id>
   <JobId>14112486-8adc-4015-be56-2261c58f2dab</JobId>
   <LastFailure/>
   <LastHttpResponseCode/>
   <LastNotification/>
   <NamingConvention>
      CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE
   </NamingConvention>
   <NotificationEndPoint>
      Spectra-S3-client-hostname
   </NotificationEndPoint>
   <NotificationHttpMethod>POST</NotificationHttpMethod>
   <NumberOfFailuresSinceLastSuccess>
      0
   </NumberOfFailuresSinceLastSuccess>
   <UserId>930460a4-0bfc-46ea-a03c-49da45944c50</UserId>
</Data>