POST /{id}

Edits a service object.

Resource Name: /network_services/{id}

Permissions Required:
  • editServiceObjects
Request URL Parameters:

Parameter

Type

Description

idMandatory

String

The network service ID.

name

String

New network service name.

addContent

Array of ServiceObject (see ServiceObject )

New network object content to add.

removeContent

Array of ServiceObject (see ServiceObject )

Content to remove from network service object.

setCustomFields

Array of KeyValuePair (see KeyValuePair )

Custom fields to assign to service object.

clearCustomFields

Array of String

Ciustom fields to clear from service object.

Return:

Parameter

Type

Description

revisionID

Integer

ID of revision.

serviceID

Integer

ID of service object.

name

String

New service object name.

Error Codes:

Errors: A failure status with the reasons or the network service object's new representation.

  • 404 (Not found) – Network service object wasn't found
  • 403 (Forbidden) - User doesn't have permission to edit network service 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_services/15
{
  "name": "new service object name",
  "addContent": [
    {
      "port": "8080",
      "protocol": "TCP"
    }
  ]
}

Return Example:

{  "revisionID": 15,  "serviceID": 2,  "name": "new service object name",}

See NetworkService for more information.

 

â See also: