v1

latestOpenAPI 3.0.02026-07-1774355.5 KB

Draw an entity

get/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

parameters.general.pixel_perfectboolean

Control if entities are represented perfectly aligned on pixels with concession on relative dimensions correctess. This parameter has no effect in axonometric graphical representations.

Control if entities are represented perfectly aligned on pixels with concession on relative dimensions correctess. This parameter has no effect in axonometric graphical representations.

parameters.room.racks_labelsboolean

Control if racks are labelled with their names

Example:true

Control if racks are labelled with their names

parameters.infrastructure.equipment_labelsboolean

Control if equipment are labelled with their names

Example:true

Control if equipment are labelled with their names

parameters.infrastructure.equipment_tagsstring[]

Draw only the equipment matching at least one of the tags.

Draw only the equipment matching at least one of the tags.

[
  "compute",
  "switch"
]
parameters.infrastructure.ghost_unselectedboolean

Control if unselected equipment are represented as ghosts in racks. When the value is true, infrastructure equipment that is not selected for the diagram is represented without details nor label just to mark its presence. When the value is false, this equipment is simply discarded.

Control if unselected equipment are represented as ghosts in racks. When the value is true, infrastructure equipment that is not selected for the diagram is represented without details nor label just to mark its presence. When the value is false, this equipment is simply discarded.

parameters.infrastructure.discard_empty_racksboolean

Control if racks used by infrastructure that contain only unselected equipment are represented.

Example:true

Control if racks used by infrastructure that contain only unselected equipment are represented.

parameters.infrastructure.other_racksboolean

Control if racks present in the rows but not used by the infrastructure are represented in infrastructure diagrams.

Control if racks present in the rows but not used by the infrastructure are represented in infrastructure diagrams.

parameters.dimensions.heightinteger

Maximum height of image in pixels

Example:1200

Maximum height of image in pixels

parameters.dimensions.widthinteger

Maximum width of image in pixels

Example:1200

Maximum width of image in pixels

parameters.margin.topinteger

Margin at the top of graphical representations.

Example:30

Margin at the top of graphical representations.

parameters.margin.leftinteger

Margin on the left of graphical representations.

Example:30

Margin on the left of graphical representations.

parameters.rack.labelsboolean

Control if racks are labelled with their names in infrastructures graphical representations

Example:true

Control if racks are labelled with their names in infrastructures graphical representations

parameters.rack.label_offsetinteger

Vertical space between row labels and racks labels in infrastructures graphical representations

Example:20

Vertical space between row labels and racks labels in infrastructures graphical representations

parameters.rack.offsetinteger

Vertical space between racks labels and racks in infrastructures graphical representations

Example:20

Vertical space between racks labels and racks in infrastructures graphical representations

parameters.rack.u_heightnumber

The height of a rack unit in millimeters

Example:44.45

The height of a rack unit in millimeters

parameters.rack.pane_widthinteger

Width of racks pane in millimeters in infrastructures graphical representations

Example:40

Width of racks pane in millimeters in infrastructures graphical representations

parameters.rack.spacinginteger

Horizontal space between racks in infrastructures graphical representations

Example:3

Horizontal space between racks in infrastructures graphical representations

parameters.rack.door_depthinteger

The depth of a door in millimeters in rooms graphical representations

Example:50

The depth of a door in millimeters in rooms graphical representations

parameters.row.labelsboolean

Control if rows are labelled with their names in infrastructures graphical representations

Example:true

Control if rows are labelled with their names in infrastructures graphical representations

parameters.row.label_offsetinteger

Space above row labels in infrastructure graphical representations

Example:20

Space above row labels in infrastructure graphical representations

backgroundnumber[]

The background color of the equipments.

bordernumber[]

The border color of the equipments.

chassisnumber[]

The color of the equipment chassis.

ghostnumber[]

The color of ghosted equipment.

left_sidenumber[]

Color of equipment left side in axonometric representations.

tagsstring[]

List of tags equipments must have to be associated to the coloring rule.

top_sidenumber[]

Color of equipment top side in axonometric representations.

typestring

Name of type of quipments associated to the coloring rule.

List of equipments coloring rules.

bottom_sidenumber[]

Inside color of racks bottom side in axonometric representations.

framenumber[]

The color of the racks frame.

left_sidenumber[]

Outside color of racks left side in axonometric representations.

panenumber[]

The color of the racks pane.

right_sidenumber[]

Inside color of racks right side in axonometric representations.

tagsstring[]

List of tags racks must have to be associated to the coloring rule.

top_sidenumber[]

Outside color of racks top side in axonometric representations.

typestring

Name of type of rack associated to the coloring rule.

List of racks coloring rules.

parameters.axonometric.enabledboolean

Axonometric graphical representation enabled?

Axonometric graphical representation enabled?

parameters.axonometric.angles.xinteger

X-angle in degrees

Example:30

X-angle in degrees

parameters.axonometric.angles.zinteger

Z-angle in degrees

Example:30

Z-angle in degrees

{"stackTrail":"paths:/v0.7.0/draw/<entity>/<name>.<format>:get:parameters:28: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

Response

successful operation