Graphs

Remove vertex collection

Remove a vertex collection from the graph and optionally the collection, if it is not used in any other graph. It only removes vertex collections that are no longer part of edge definitions.

Note: Requires administrator permissions.

delete/_fabric/{fabric}/_api/graph/{graph}/vertex/{collection}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/graph/:graph/vertex/:collection/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fabricstring string required

The name of the fabric.

graphstring string required

The name of the graph.

collectionstring string required

The name of the vertex collection.

Query parameters

dropCollectionboolean

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

Response

Successfully removed vertex collection 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": 200,
  "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.