REST API for Unified Assurance Core

Update an Edge Type

put

/api/graph/EdgeTypes/{id}

Updates the properties of the edge type that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The edge type ID.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

Direction: string
The edge tip style. Allowed values are:
- Non-Directed: The edge has no arrows on the tips.
- Directional: The edge has an arrow pointing from source to target.
Example: Non-Directed
EdgeTypeName: string

The edge type name. The name may not contain spaces, commas, or backticks.
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: ConnectsInterface
LineTypeID: integer
The line type ID. Allowed values are:
- 0: Solid
- 1: Dashed
- 2: Dotted
Example: 0

{
    "properties":{
        "EdgeTypeName":{
            "description":"The edge type name. The name may not contain spaces, commas, or backticks.\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":"ConnectsInterface"
        },
        "LineTypeID":{
            "description":"The line type ID. Allowed values are:\n<ul><li><b>0</b>: Solid</li>\n<li><b>1</b>: Dashed</li>\n<li><b>2</b>: Dotted</li></ul>",
            "type":"integer",
            "example":0
        },
        "Direction":{
            "description":"The edge tip style.\nAllowed values are:\n<ul><li><b>Non-Directed</b>: The edge has no arrows on the tips.</li>\n<li><b>Directional</b>: The edge has an arrow pointing from source to target.</li></ul>",
            "type":"string",
            "example":"Non-Directed"
        }
    },
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/graphEdgeTypesRead"
                    }
                }
            }
        }
    ]
}

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
total: integer

The total number of results regardless of paging.

Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/graphEdgeTypesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object graphEdgeTypesRead

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

Nested Schema : graphEdgeTypesRead

Type: object

Show Source

Direction: string

Indicator of the edge tip style. Directional indicates the edge has an arrow pointing from source to target. Non-Directional indicates the edge has no arrows on the tips. Allowed Values: - Non-Directional - Directional

Example: Non-Directed
EdgeTypeID: integer

Edge Type ID

Example: 3
EdgeTypeName: string

Edge Type Name

Example: ConnectsInterface
LineStyle: string

Line Style Allowed Values - Solid - Dashed - Dotted

Example: Solid
LineTypeID: integer

Line Type ID - 0 => Solid - 1 => Dashed - 2 => Dotted

Example: 0

{
    "properties":{
        "EdgeTypeID":{
            "description":"Edge Type ID",
            "type":"integer",
            "example":3
        },
        "EdgeTypeName":{
            "description":"Edge Type Name",
            "type":"string",
            "example":"ConnectsInterface"
        },
        "Direction":{
            "description":"Indicator of the edge tip style. Directional indicates the edge has an arrow pointing from source to target. Non-Directional indicates the edge has no arrows on the tips.\n\nAllowed Values:\n-  Non-Directional\n-  Directional",
            "type":"string",
            "example":"Non-Directed"
        },
        "LineTypeID":{
            "description":"Line Type ID\n\n- 0 => Solid\n- 1 => Dashed\n- 2 => Dotted",
            "type":"integer",
            "example":0
        },
        "LineStyle":{
            "description":"Line Style\n\nAllowed Values\n- Solid\n- Dashed\n- Dotted",
            "type":"string",
            "example":"Solid"
        }
    },
    "type":"object"
}

Default Response

Failed operation

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.