Spectra Logic

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

Create Job Completed Notification Registration

Description

Create a notification registration for job completed events.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/job_completed_notification_registration/?notification_end_point={string}[&format=DEFAULT|JSON|XML] [&job_id={string}]​[&naming_convention=CONCAT_LOWERCASE|CONSTANT|​​​UNDERSCORED|​CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE| CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE] [&notification_http_method=POST|PUT]

 

Request Parameters

Parameter	Description	Required
notification_end_ point	The HTTP or HTTPS URL of a web server capable of receiving notification messages from the BlackPearl Deep Storage Gateway.	yes
format	The format of the notification. Values: DEFAULT (XML), JSON, XML	no
job_id	The UUID or a unique attribute for the job. If not included, notifications are sent for all jobs.	no
naming_ convention	The scheme used for naming within the notification sent. Values: CONCAT_LOWERCASE, CONSTANT, UNDERSCORED, CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE (default), CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE	no
notification_http_ method	The HTTP request method type used to send the notification. Values: POST (default), PUT	no

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 Deep Storage Gateway.
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 Deep Storage Gateway.
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 creates a registration for job completed notifications to be sent to Spectra-S3-client-hostname.

POST http://blackpearl-hostname/_rest_/job_completed_notification_registration/?notification_end_point=Spectra-S3-client-hostname HTTP/1.1

Sample Response

HTTP/1.1 201 OK
<Data>
   <CreationDate>2014-10-02T11:40:25.683Z</CreationDate>
   <Format>DEFAULT</Format>
   <Id>e2ae9bc2-d70e-46d4-9af7-82d971827cb8</Id>
   <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>2bb8b755-857b-4eec-91cd-cef188f55aac</UserId>
</Data>

Sample Notification Payload

Below is a sample job completed notification payload:

<Name>JobCompletedNotificationPayload</Name>

<Payload>

   <CancelOccurred>TRUE</CancelOccurred>
   <JobId>d7f5e47c-fbe6-4067-b834-9f829f150333</JobId>
   <NotificationGenerationDate/>
   <ObjectsNotPersisted Length="100" Name="o1" Offset="0"/>
   <ObjectsNotPersisted Length="100" Name="o2" Offset="0"/>

</Payload>