Jump to

• Request
• Response

Update an Element Vertex

put

/api/gateway/Elements/{id}

Updates an existing element vertex identified by element object ID. This method allows you to make changes to the properties of an element vertex.

Request

Path Parameters

• id(required): integer(int32)
  The element Object ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Commands: array Commands
  Poll Commands to run on network element. The order listed is the order commands will be run.
• CTAG: string
  Element CTAG

  Example: ctag
• Description: string
  Description of the Element.

  Example:
• ElementName: string
  The gateway element name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Element1
• GatewayID: string
  Parent Gateway

  Example: 18b88a04-5b5d-455c-bc9e-0ad28cf7aee0
• LoginCommand: string
  Command to login to the element.

  Example: act
• LogoutCommand: string
  Command to logout of the element.

  Example: canc
• PollTimer: integer
  Seconds to wait after running each poll command.

  Example: 30
• TID: string
  Element TID

  Example: tid

{
    "properties":{
        "ElementName":{
            "description":"The gateway element name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Element1"
        },
        "Description":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/Description"
        },
        "GatewayID":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/GatewayID"
        },
        "TID":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/TID"
        },
        "CTAG":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/CTAG"
        },
        "LoginCommand":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/LoginCommand"
        },
        "LogoutCommand":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/LogoutCommand"
        },
        "Commands":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/Commands"
        },
        "PollTimer":{
            "$ref":"#/components/schemas/gatewayElementsRead/properties/PollTimer"
        }
    },
    "type":"object"
}

Nested Schema : Commands

Type: array

Poll Commands to run on network element. The order listed is the order commands will be run.

Show Source

• Array of:

{
    "description":"Poll Commands to run on network element. The order listed is the order commands will be run.",
    "type":"array",
    "items":{
    },
    "example":[
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/gatewayElementsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/gatewayElementsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object gatewayElementsRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/gatewayElementsRead"
    }
}

Nested Schema : gatewayElementsRead

Type: object

Show Source

• Commands: array Commands
  Poll Commands to run on network element. The order listed is the order commands will be run.
• CTAG: string
  Element CTAG

  Example: ctag
• Description: string
  Description of the Element.

  Example:
• ElementID: string
  Unique identifier for the element.

  Example: 825f3a56-2697-49e1-a3e6-375dd6fe61eb
• ElementName: string
  The name of the element, which must be unique within the database.

  Example: Element1
• GatewayID: string
  Parent Gateway

  Example: 18b88a04-5b5d-455c-bc9e-0ad28cf7aee0
• GatewayName: string
  The parent gateway for the element.

  Example: Gateway1
• LoginCommand: string
  Command to login to the element.

  Example: act
• LogoutCommand: string
  Command to logout of the element.

  Example: canc
• PollTimer: integer
  Seconds to wait after running each poll command.

  Example: 30
• TID: string
  Element TID

  Example: tid

{
    "properties":{
        "ElementID":{
            "description":"Unique identifier for the element.",
            "type":"string",
            "example":"825f3a56-2697-49e1-a3e6-375dd6fe61eb"
        },
        "ElementName":{
            "description":"The name of the element, which must be unique within the database.",
            "type":"string",
            "example":"Element1"
        },
        "Description":{
            "description":"Description of the Element.",
            "type":"string",
            "example":""
        },
        "TID":{
            "description":"Element TID",
            "type":"string",
            "example":"tid"
        },
        "CTAG":{
            "description":"Element CTAG",
            "type":"string",
            "example":"ctag"
        },
        "LoginCommand":{
            "description":"Command to login to the element.",
            "type":"string",
            "example":"act"
        },
        "LogoutCommand":{
            "description":"Command to logout of the element.",
            "type":"string",
            "example":"canc"
        },
        "PollTimer":{
            "description":"Seconds to wait after running each poll command.",
            "type":"integer",
            "example":30
        },
        "Commands":{
            "description":"Poll Commands to run on network element. The order listed is the order commands will be run.",
            "type":"array",
            "items":{
            },
            "example":[
            ]
        },
        "GatewayID":{
            "description":"Parent Gateway",
            "type":"string",
            "example":"18b88a04-5b5d-455c-bc9e-0ad28cf7aee0"
        },
        "GatewayName":{
            "description":"The parent gateway for the element.",
            "type":"string",
            "example":"Gateway1"
        }
    },
    "type":"object"
}

Nested Schema : Commands

Type: array

Poll Commands to run on network element. The order listed is the order commands will be run.

Show Source

• Array of:

{
    "description":"Poll Commands to run on network element. The order listed is the order commands will be run.",
    "type":"array",
    "items":{
    },
    "example":[
    ]
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top