POST /{id}
Edits network object.
Resource Name: /network_objects/{id}
Permissions Required:- editNetworkObjects
Parameter |
Type |
Description |
---|---|---|
idMandatory |
String |
The network object ID. |
name |
String |
New flow name. |
content |
String |
New network object content. |
addMembers |
Array of NetworkObject (see NetworkObject ) |
New members to add to the network object group. Note: Only applied when network object is defined as a group. |
removeMembers |
Array of NetworkObject (see NetworkObject ) |
Members to remove from network object group. Note: Only applied when network object is defined as a group. |
setCustomFields |
Array of KeyValuePair (see KeyValuePair ) |
Custom fields to assign to network object. |
clearCustomFields |
Array of String |
Custom fields to clear from network object. |
Return:
Parameter |
Type |
Description |
---|---|---|
changeRequest |
ChangeRequest (see ChangeRequest ) |
Opened change request, if needed. |
networkObject |
NetworkObjectEntity (see NetworkObject ) |
Network object after changes applied. |
Errors: A failure status with the reasons or the network object's new representation.
- 404 (Not found) – Network object wasn't found
- 403 (Forbidden) - User doesn't have permission to edit network object
- 400 (Bad request) – Revision ID is not the latest revision.
- 400 (Bad request) – Object isn’t editable due to status.
- 400 (Bad request) – Duplicate name
- 400 (bad request) – Request parameter has wrong or missing value.
Request example:
POST <ip:port>/BusinessFlow/rest/v1/network_objects/15
[
{
"name": "new network object name",
"content": "10.6.9.14"
}
]
Return Example:
{ "networkObject": { "revisionID": 15, "objectID": "2", "name": "new network object name", … } }
See NetworkObject (see NetworkObject ) for more information.
â See also: