Create a new graph

POST 
/graphs

Create a new graph.

Request

application/json

Body

required

name stringrequired
nodes object[]required
Array [
id number
name string
type string
orientation boolean
pose object
]
edges object[]required
Array [
id number
name string
type string
orientation boolean
pose object
bidirectional boolean
weight number
source number
target number
]

Responses

201

Graph created

application/json

Schema

Schema

_id uuid
name string
nodes object[]
Array [
id number
name string
type string
orientation boolean
_id uuid
createdAt date-time
updatedAt date-time
]
edges object[]
Array [
id number
name string
orientation boolean
bidirectional boolean
type string
direction string
weight number
source number
target number
_id uuid
createdAt date-time
updatedAt date-time
]
createdAt date-time
updatedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "nodes": [
    {
      "id": 0,
      "name": "string",
      "type": "string",
      "orientation": true,
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-12-03T13:25:45.027Z",
      "updatedAt": "2024-12-03T13:25:45.027Z"
    }
  ],
  "edges": [
    {
      "id": 0,
      "name": "string",
      "orientation": true,
      "bidirectional": true,
      "type": "string",
      "direction": "string",
      "weight": 0,
      "source": 0,
      "target": 0,
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-12-03T13:25:45.029Z",
      "updatedAt": "2024-12-03T13:25:45.029Z"
    }
  ],
  "createdAt": "2024-12-03T13:25:45.029Z",
  "updatedAt": "2024-12-03T13:25:45.029Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

409

A graph with the given details already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "A graph with the given details already exists."
}

Example

{
  "message": "A graph with the given details already exists."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...