Jump to

• Request
• Response

Get an Edge by ID

get

/api/graph/Edges/{id}

Gets the edge that matches the specified ID.

Request

Path Parameters

• id(required): string
  The edge ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

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

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get 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":"Loaded 1 entries"
        }
    },
    "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/graphEdgesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object graphEdgesRead

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

Nested Schema : graphEdgesRead

Type: object

Show Source

• EdgeID: string
  Edge ID

  Example: 4a611c07-d077-4438-a0b3-d42e7ff488ad_18b88a04-5b5d-455c-bc9e-0ad28cf7aee0_825f3a56-2697-49e1-a3e6-375dd6fe61eb
• EdgeProps: array EdgeProps
  Edge Properties
• EdgeTypeID: integer
  Edge Type ID

  Example: 7
• EdgeTypeName: string
  Edge Type Name

  Example: HasTL1Element
• InVertexCustomName: string
  Target Vertex Custom Name

  Example:
• InVertexID: string
  Target Vertex ID

  Example: 825f3a56-2697-49e1-a3e6-375dd6fe61eb
• InVertexName: string
  Target Vertex Name

  Example: Element1
• OutVertexCustomName: string
  Source Vertex Custom Name

  Example:
• OutVertexID: string
  Source Vertex ID

  Example: 18b88a04-5b5d-455c-bc9e-0ad28cf7aee0
• OutVertexName: string
  Source Vertex Name

  Example: Gateway1
• TimestampModified: integer
  Time Stamp Modified

  Example: 1692196209706
• TimestampModifiedString: string
  Time Stamp Modified String

  Example: 2023-08-16 09:30:09

{
    "properties":{
        "EdgeTypeID":{
            "description":"Edge Type ID",
            "type":"integer",
            "example":7
        },
        "EdgeTypeName":{
            "description":"Edge Type Name",
            "type":"string",
            "example":"HasTL1Element"
        },
        "OutVertexID":{
            "description":"Source Vertex ID",
            "type":"string",
            "example":"18b88a04-5b5d-455c-bc9e-0ad28cf7aee0"
        },
        "OutVertexName":{
            "description":"Source Vertex Name",
            "type":"string",
            "example":"Gateway1"
        },
        "OutVertexCustomName":{
            "description":"Source Vertex Custom Name",
            "type":"string",
            "example":""
        },
        "InVertexID":{
            "description":"Target Vertex ID",
            "type":"string",
            "example":"825f3a56-2697-49e1-a3e6-375dd6fe61eb"
        },
        "InVertexName":{
            "description":"Target Vertex Name",
            "type":"string",
            "example":"Element1"
        },
        "InVertexCustomName":{
            "description":"Target Vertex Custom Name",
            "type":"string",
            "example":""
        },
        "EdgeProps":{
            "description":"Edge Properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyName":{
                        "description":"The property name.",
                        "type":"string",
                        "example":"EdgeActiveType"
                    },
                    "PropertyValue":{
                        "description":"The property value.",
                        "type":"string",
                        "example":"Metric"
                    }
                }
            },
            "example":[
                {
                    "PropertyName":"EdgeActiveType",
                    "PropertyValue":"Metric"
                }
            ]
        },
        "EdgeID":{
            "description":"Edge ID",
            "type":"string",
            "example":"4a611c07-d077-4438-a0b3-d42e7ff488ad_18b88a04-5b5d-455c-bc9e-0ad28cf7aee0_825f3a56-2697-49e1-a3e6-375dd6fe61eb"
        },
        "TimestampModified":{
            "description":"Time Stamp Modified",
            "type":"integer",
            "example":"1692196209706"
        },
        "TimestampModifiedString":{
            "description":"Time Stamp Modified String",
            "type":"string",
            "example":"2023-08-16 09:30:09"
        }
    },
    "type":"object"
}

Nested Schema : EdgeProps

Type: array

Edge Properties

Show Source

• Array of: object items

{
    "description":"Edge Properties",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyName":{
                "description":"The property name.",
                "type":"string",
                "example":"EdgeActiveType"
            },
            "PropertyValue":{
                "description":"The property value.",
                "type":"string",
                "example":"Metric"
            }
        }
    },
    "example":[
        {
            "PropertyName":"EdgeActiveType",
            "PropertyValue":"Metric"
        }
    ]
}

Example:

[
    {
        "PropertyName":"EdgeActiveType",
        "PropertyValue":"Metric"
    }
]

Nested Schema : items

Type: object

Show Source

• PropertyName: string
  The property name.

  Example: EdgeActiveType
• PropertyValue: string
  The property value.

  Example: Metric

{
    "type":"object",
    "properties":{
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"EdgeActiveType"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"string",
            "example":"Metric"
        }
    }
}

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