Register a notification (POST)
Description
URL |
scheme://domain:port/platform/ws/notifications/register |
|
Description |
Registers notifications for a workload. |
|
HTTP Method |
POST |
|
Parameters |
Name |
Description |
workloadId |
Required. ID of an LSF job or a flow. |
Request
Request |
Request Information |
|
Method |
POST |
|
Request-URI |
/platform/ws/notifications/register |
|
Request-Header |
Name |
Value |
Accept |
application/xml or application/json |
|
Message-Body |
Field format/value |
Notes |
|
<id>%s</id> defines the parameter name. The possible values are:
<value>%s</value> defines the value of the parameter. Possible values are:
Example:
|
Response
Response Code |
|
|
Response-Header |
Name |
Value |
Content-Type |
application/xml or application/json |
|
Message-body |
Success Message |
|
Failure Message |
If not successful, returns an error message. For additional information, refer to the schema file ./schemas/jobs/error.xsd.
|
Example:
# Request
POST /platform/webservice/notifications/register?workloadId=150 HTTP/1.1
Host: www.example.org
Cookie: platform_token=%s
Content-Type: application/xml
Accept: application/xml
<NotificationParams>
<AppParam>
<id>NOTIFY_ENABLE</id>
<value>Y</value>
</AppParam>
<AppParam>
<id>NOTIFY_EVENTS</id>
<value>END,EXIT</value>
</AppParam>
<AppParam>
<id>NOTIFY_CHANNELS</id>
<value>BROWSER,EMAIL</value>
</AppParam>
</NotificationParams>
# Response
200 Successful