Jump to

• Request
• Response

Create an Edge Type

post

/api/graph/EdgeTypes

Creates an edge type.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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
• EdgeTypeName: string
  Edge Type Name

  Example: ConnectsInterface
• LineTypeID: integer
  Line Type ID - 0 => Solid - 1 => Dashed - 2 => Dotted

  Example: 0

{
    "properties":{
        "EdgeTypeName":{
            "description":"Edge Type Name",
            "type":"string",
            "example":"ConnectsInterface"
        },
        "LineTypeID":{
            "description":"Line Type ID\n- 0 => Solid\n- 1 => Dashed\n- 2 => Dotted",
            "type":"integer",
            "example":0
        },
        "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"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "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 : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

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

  Example: true

{
    "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":"Added 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

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":{
                "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

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

Nested Schema : items

Type: object

Back to Top