v1

latestOpenAPI 3.0.02026-07-1774355.5 KB

Draw an entity

post/v0.7.0/draw/<entity>/<name>.<format>

Path parameters

entity'infrastructure' | 'room' required

Type of entity to draw

namestring required

Name of entity

format'png' | 'svg' | 'pdf' required

Format of the generated image

Query parameters

{"stackTrail":"paths:/v0.7.0/draw/<entity>/<name>.<format>:post:parameters:3:schema","oasType":"schema","type":"unknown"}

Dump equipments and racks coordinates in diagrams. When this parameter is set, the mimetype of the response is multipart/form-data.

coordinates_format'json' | 'yaml'

Format of coordinates

Request body

Example request

{
  "axonometric": {
    "angles": {
      "x": 30,
      "z": 30
    }
  },
  "colors": {
    "equipments": [],
    "racks": []
  },
  "dimensions": {
    "height": 1200,
    "width": 1200
  },
  "infrastructure": {
    "discard_empty_racks": true,
    "equipment_labels": true,
    "equipment_tags": [
      "compute",
      "switch"
    ]
  },
  "margin": {
    "left": 30,
    "top": 30
  },
  "rack": {
    "door_depth": 50,
    "label_offset": 20,
    "labels": true,
    "offset": 20,
    "pane_width": 40,
    "spacing": 3,
    "u_height": 44.45
  },
  "room": {
    "racks_labels": true
  },
  "row": {
    "label_offset": 20,
    "labels": true
  }
}

Response

successful operation