MAmacrometa
Graphs

Remove an edge definition

Remove one edge definition from the graph. This only removes the edge collection, the vertex collections can still be used in your queries.

Note: Requires administrator permissions.

delete/_fabric/{fabric}/_api/graph/{graph}/edge/{edgeCollection}

Request

Path parameters

fabricstring string required

The name of the fabric.

graphstring string required

The name of the graph.

edgeCollectionstring string required

The name of the edge collection the edge belongs to.

Query parameters

dropCollectionsboolean

Set true to remove the collection. Collection is only removed if it is not used in other graphs.

Response

Successfully removed edge definition when waitForSync is enabled.

codeinteger

HTTP response code.

errorboolean required

Flag if there is an error in response. False for this response.

Example response

{
  "code": 201,
  "graph": {
    "_id": "_graphs/graph1",
    "_key": "graph1",
    "_rev": "_drxzsai--_",
    "edgedefinitions": [
      {
        "collection": "edgeName",
        "from": [
          "sourceNode"
        ],
        "to": [
          "destinationNode"
        ]
      }
    ],
    "name": "graph1",
    "orphanCollections": [
      "emptyNode"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.