Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Update Nodes

Use the POST method to update a node in EDS.

POST Request in JSON Format

Generate a POST request. For example, the following POST request updates a node:

POST /api/nodes/{node-id}

Content-Type: application/json
Accept: application/json
x-http-method-override: PUT

POST Body in JSON Format

The following is a sample POST body in JSON format:

{
    "nodes":
        [
            {"id": 1, "name": "MyNode1Chnaged"}, 
            {"id": 2, "name": "MyNode2Changed", "nodeGroups": [5, 8]}, 
        ] 
}

POST Response in JSON Format

The following are sample responses for the 200 OK code:

{
    "total": 1,
    "count": 1,
    "success": true,
    "items": 
    [
        {
            "id": {node-id},
            "name": {node-name},
            "nodeGroups": [{"id": {nodegroup-id}, "name": {nodegroup-name}, "type": "dynamic", "pattern": {node-pattern-regex}}]
        }
    ]
}

{
    "total": 2,
    "count": 2,
    "success": true,
    "items": 
    [
        {
            "id": {node-id},
            "name": {node-name},
            "nodeGroups": [{"id": {nodegroup-id}, "name": {nodegroup-name}, "type": "dynamic", "pattern": {node-pattern-regex}}]
        },
        {
            "id": {node-id},
            "name": {node-name},
            "nodeGroups": [{"id": {nodegroup-id}, "name": {nodegroup-name}, "type": "static"}]
        }
    ]
}

The following is a sample response for the 404 Not Found code:

{
    "success": false,
    "errors": 
        [
            {
            "code": NODE_NOT_FOUND,
            "parameters": [{node-id}],
            "errorMessage": "Node with Id: {node-id} not found"
            }
        ]
}

The following are sample responses for the 400 Bad Request code:

{
    "success": false,
    "errors": 
        [
            {
            "code": NAME_FIELD_MISSING,
            "parameters": null,
            "errorMessage": "'name' field is missing in request"
            }
        ]
}

{
    "success": false,
    "errors": 
        [
            {
            "code": NODEGROUP_NOT_FOUND,
            "parameters": [{nodegroup-id}],
            "errorMessage": "Nodegroup not found with Id: {nodegroup-id}"
            }
        ]
}

{
    "success": false,
    "errors": 
        [
            {
            "code": NODE_NAME_ALREADY_EXISTS,
            "parameters": null,
            "errorMessage": "Node name already exists."
            }
        ]
}

The following is a sample response for the 500 Internal Server Error code:

{
    "success": false,
    "errors": 
        [
            {
            "code": INTERNAL_SERVER_ERROR,
            "parameters": [{error-message}],
            "errorMessage": "Failed to update Node. Exception: {error-message}"
            }
        ]
}

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Update Nodes

Update Nodes

POST Request in JSON Format

POST Body in JSON Format

POST Response in JSON Format