Spectra Logic

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

Get Job Completed Notification Registrations

Description

Get a list of all job completed notification registrations.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/job_completed_notification_registration[?last_page]​[&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}][&user_id={string}]

Request Parameters

Parameter	Description	Required
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of registrations to list. The default is all items after page_offset.	no
page_offset	The starting point for the first registration to list. The default is 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
user_id a	The UUID, username, or other unique attribute for the user who created the notification registration.	no

a.	Parameter values can use wild cards (see Wild Card Syntax).

Responses

Response Elements

<Data>
   <JobCompletedNotificationRegistration>
      <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>
   </JobCompletedNotificationRegistration>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
JobCompleted Notification Registration	The container for the information for a single notification registration.
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 all job completed notification registrations.

GET http://blackpearl-hostname/_rest_/job_completed_notification_registration/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <JobCompletedNotificationRegistration>
      <CreationDate>2014-10-16T18:33:53.31Z</CreationDate>
      <Format>DEFAULT</Format>
      <Id>14362d62-2d3c-490e-b369-34df3dcb474a</Id>
      <JobId>1999523d-df6f-4c22-b8b2-82becc55e0a2</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>2cc42ec3-fb32-4fcb-a421-437f5fb18531</UserId>
   </JobCompletedNotificationRegistration>
   ...
</Data>