You can assign the notification-destination email addresses to a specific notification profile.
Execution permission
Admin, Modify
Request line
POST baseURL/v1/objects/NotificationProfile/{id}/actions/updateTargetMailAddress/invoke
Request body
The structure of the request body and the object attributes are as follows:Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of UpdateTargetMailAddressParam objects necessary to execute an operation. For details, see the table below. |
UpdateTargetMailAddressParam
{
"mailAddressIDs":["...", ...]
}
UpdateTargetMailAddressParam (Type: UpdateTargetMailAddressParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
mailAddressIDs |
string[] |
Specify the IDs of all email addresses to be assigned as the destination addresses. If there are email addresses that have already been assigned, they are de-assigned by not specifying their IDs. To de-assign all email addresses, specify an empty list. |
Response body
The structure of the response body and the object attributes is as follows:Job
{
"instanceID":"...",
"created":"...",
"updated":"...",
"completed":"...",
"state":"...",
"affectedResource":["...", ...],
"result":["...", ...]
}
Job (Type: Job)
|
Attribute |
Type |
Description |
|---|---|---|
|
instanceID |
string |
ID of the Instance. |
|
created |
string |
Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00). |
|
updated |
string |
Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00). |
|
completed |
string |
Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00). |
|
state |
string |
One of the following values is set: "failed": The operation failed. "success": The operation completed successfully. |
|
affectedResource |
string[] |
A blank space is set. |
|
result |
anyType[] |
A list of objects. No value is set. |
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
400 |
Bad Request |
The format of the request body is invalid. |
|
401 |
Unauthorized |
No login privilege. |
|
403 |
Forbidden |
No update privilege. |
|
404 |
Not Found |
The resource was not found. |
|
412 |
Precondition Failed |
The server is not available. |
|
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header]
POST
http://10.197.198.241:22015/Analytics/v1/objects/NotificationProfile/notificationProfile%232efedee0-2bab-4560-ada1-8bfeab7cfd94/actions/updateTargetMailAddress/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json
[Request Body]
{
"name": "updateTargetMailAddress",
"href": "http://localhost:22015/Analytics/v1/objects/NotificationProfile/notificationProfile%232efedee0%2d2bab%2d4560%2dada1%2d8bfeab7cfd94/actions/updateTargetMailAddress/invoke",
"method": "POST",
"type": "application/json",
"parameters":[{
"mailAddressIDs":["mailAddress#8610bd0e-d8f1-4a15-8a6f-cd1505cf7b73"]
}]
}
[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:55:30 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"instanceID" : "5f41abb9-16bc-4a23-b2c2-c928d4d0e976",
"created" : "2016-08-12T02:55:30.457+09:00",
"updated" : "2016-08-12T02:55:30.457+09:00",
"completed" : "2016-08-12T02:55:30.457+09:00",
"state" : "success",
"affectedResource" : [ ],
"result" : [ ]
}